Skip to content
This repository was archived by the owner on Jan 11, 2024. It is now read-only.

Commit 9aaaef3

Browse files
authored
docs: move urls to new website (#1660)
Signed-off-by: Giovanni Liva <[email protected]>
1 parent 62baebf commit 9aaaef3

File tree

166 files changed

+252
-298
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

166 files changed

+252
-298
lines changed
+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
contact_links:
22
- name: Discuss on Slack
3-
url: "https://keptn.sh/community/#slack"
3+
url: "https://v1.keptn.sh/community/#slack"
44
about: You can discuss Keptn website in the keptn-website and keptn-docs channels on Keptn Slack

.github/workflows/auto-update.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ jobs:
7373
./dist/keptn generate docs --dir="$DOCS_PATH"
7474
7575
# Replaces All Occurences of version links with a relative path
76-
find $DOCS_PATH -print -type f -name '*.md' -exec sed -i "s@https://keptn.sh/docs/[[:digit:]][^/]*/@${RELATIVE_PATH}@g" {} \;
76+
find $DOCS_PATH -print -type f -name '*.md' -exec sed -i "s@https://v1.keptn.sh/docs/[[:digit:]][^/]*/@${RELATIVE_PATH}@g" {} \;
7777
7878
- name: Create Pull Request
7979
uses: peter-evans/create-pull-request@v4

CONTRIBUTING.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contribute to the Keptn website
22

3-
This document provides information about contributing to the [Keptn documentation](https://keptn.sh/docs/), which is part of the [Keptn](https://keptn.sh) website.
3+
This document provides information about contributing to the [Keptn documentation](https://v1.keptn.sh/docs/), which is part of the [Keptn](https://keptn.sh) website.
44

55
This documentation is authored with [markdown](https://www.markdownguide.org/basic-syntax/)
66
and rendered using the [Hugo static website generator framework](http://gohugo.io).
@@ -11,7 +11,7 @@ this works well for small modifications but, if you are making significant chang
1111
You can also run the [Hugo](https://gohugo.io/) based website locally to check the rendered documentation
1212
and then push your changes to the repository as a pull request.
1313

14-
If you need help getting started, feel free to ask for help on the `#help-contributing` or `#keptn-docs` channels on the [Keptn Slack](https://keptn.sh/community/#slack).
14+
If you need help getting started, feel free to ask for help on the `#help-contributing` or `#keptn-docs` channels on the [Keptn Slack](https://v1.keptn.sh/community/#slack).
1515
We were all new to this once and are happy to help you!
1616

1717
## Notes about markdown
@@ -209,7 +209,7 @@ When *grip* is installed, you can format the specified file locally by running t
209209
210210
## Source file structure
211211
212-
The source files for the [Keptn Documentation](https://keptn.sh/docs/) are stored under the *content/docs* directory in the repository.
212+
The source files for the [Keptn Documentation](https://v1.keptn.sh/docs/) are stored under the *content/docs* directory in the repository.
213213
The build strategy is to build everything except for the files/folders that are listed in the `ignoreFiles` array in the [config.toml](https://github.com/keptn/keptn.github.io/blob/master/config.toml) file.
214214
215215
The order in which the files are displayed is determined by the value of the `weight` field in the metadata section of *_index.md* and *index.md* files located throughout the directory tree.

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Keptn Website
22

3-
[![Channel on Slack](https://img.shields.io/badge/Slack-%23keptn--website-green)](https://keptn.sh/community/#slack)
3+
[![Channel on Slack](https://img.shields.io/badge/Slack-%23keptn--website-green)](https://v1.keptn.sh/community/#slack)
44
![Powered by Netlify](https://img.shields.io/netlify/5b8b8c0a-121b-4216-bf17-eec11b2f2391)
55

66
The Keptn project has a static website powered by [Hugo](https://gohugo.io/) and [Netlify](https://www.netlify.com/).

_redirects

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
https://keptn.netlify.com/* https://keptn.sh/:splat 301!
1+
https://keptn.netlify.com/* https://v1.keptn.sh/:splat 301!

assets/js/scripts.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@ if (body.classList.contains('page-home')) {
1919
logoIntro.classList.add('is-sticky');
2020
logo.classList.add('is-sticky');
2121
hamburgerInner.classList.add('is-sticky');
22-
logoJS.src = 'https://keptn.sh/images/logo.svg';
22+
logoJS.src = 'https://v1.keptn.sh/images/logo.svg';
2323
}
2424
} else {
2525
header.classList.remove('is-sticky');
2626
logoIntro.classList.remove('is-sticky');
2727
logo.classList.remove('is-sticky');
2828
hamburgerInner.classList.remove('is-sticky');
29-
logoJS.src = 'https://keptn.sh/images/home/hero/keptn-logo-white.svg';
29+
logoJS.src = 'https://v1.keptn.sh/images/home/hero/keptn-logo-white.svg';
3030
}
3131
});
3232

@@ -55,7 +55,7 @@ if (body.classList.contains('page-home')) {
5555
shuffle(randomLogoNumbers);
5656
var counter = 0;
5757
happyUserLogos.forEach(logo => {
58-
logo.src = 'https://keptn.sh/images/home/happy-users/logos/logo-' + randomLogoNumbers[counter] + '.png';
58+
logo.src = 'https://v1.keptn.sh/images/home/happy-users/logos/logo-' + randomLogoNumbers[counter] + '.png';
5959
counter = ++counter;
6060
});
6161
});

config.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# baseURL = "https://keptn.sh/"
1+
# baseURL = "https://v1.keptn.sh/"
22
languageCode = "en-us"
33
title = "keptn | Cloud-native application life-cycle orchestration"
44
theme = "hugo-serif-theme"

content/community/contributing/index.md

+1-5
Original file line numberDiff line numberDiff line change
@@ -47,14 +47,10 @@ If you are interested, join the `#keptn-docs` channel on the Keptn Slack workspa
4747

4848
Major documentation areas:
4949

50-
* Documentation ([keptn.sh/docs](https://keptn.sh/docs/)) - extend and improve the documentation for Keptn
50+
* Documentation ([keptn.sh/docs](https://v1.keptn.sh/docs/)) - extend and improve the documentation for Keptn
5151
* [GitHub Repository](https://github.com/keptn/keptn.github.io/)
5252
* [How to contribute?](https://github.com/keptn/keptn.github.io/blob/master/CONTRIBUTING.md)
5353
* [Good First Issues](https://github.com/keptn/keptn.github.io/labels/good%20first%20issue)
54-
* Tutorials ([tutorials.keptn.sh](https://tutorials.keptn.sh/)) - add new tutorials and extend the existing ones to help newcomer users to study Keptn, and to integrate it into their application management.
55-
* [GitHub Repository](https://github.com/keptn/tutorials)
56-
* [How to contribute?](https://github.com/keptn/tutorials/blob/master/CONTRIBUTING.md)
57-
* [Good First Issues](https://github.com/keptn/tutorials/labels/good%20first%20issue)
5854
* Services and Components Documentation - many components, e.g. the [Prometheus Service for Keptn](https://github.com/keptn-contrib/prometheus-service), have documentation as a part of their repositories. Patches are welcome there too!
5955
* [Keptn Examples](https://github.com/keptn/examples) - expand and document Keptn examples that can be used by end users
6056
* Contributing guidelines

content/docs/0.10.x/reference/bridge/_index.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -175,13 +175,13 @@ You can find links to for different integration possibilities here. This makes i
175175
integrations for different CI providers.
176176

177177
Please note that the page contains dynamic content that is loaded from https://get.keptn.sh/integrations.html. By clicking the button the data is requested,
178-
and additional data is gathered from the client. For more information about this see https://keptn.sh/docs/0.10.x/reference/load_information/.
178+
and additional data is gathered from the client. For more information about this see https://v1.keptn.sh/docs/0.10.x/reference/load_information/.
179179

180180
### Settings
181181

182182
#### Project settings
183183
In the settings view the project settings can be edited.
184-
To get more information about how to manage your projects with the settings, visit [Manage Projects](https://keptn.sh/docs/0.10.x/reference/bridge/manage_projects).
184+
To get more information about how to manage your projects with the settings, visit [Manage Projects](https://v1.keptn.sh/docs/0.10.x/reference/bridge/manage_projects).
185185

186186
{{< popup_image
187187
link="./assets/project-settings.png"
@@ -190,7 +190,7 @@ caption="Keptn Bridge Project Settings View">}}
190190

191191
#### Service settings
192192
In this view, services can be created, updated and deleted.
193-
To get more information about how services can be managed in your settings, visit [Manage Services](https://keptn.sh/docs/0.10.x/reference/bridge/manage_services).
193+
To get more information about how services can be managed in your settings, visit [Manage Services](https://v1.keptn.sh/docs/0.10.x/reference/bridge/manage_services).
194194

195195
{{< popup_image
196196
link="./assets/service-settings.png"
@@ -201,7 +201,7 @@ caption="Keptn Bridge Service Settings View">}}
201201

202202
### Approvals
203203

204-
If you have a [manual approval strategy](https://keptn.sh/docs/0.10.x/continuous_delivery/multi_stage/#approval) defined in your shipyard.yaml file, approvals can be handled with the Keptn Bridge.
204+
If you have a [manual approval strategy](https://v1.keptn.sh/docs/0.10.x/continuous_delivery/multi_stage/#approval) defined in your shipyard.yaml file, approvals can be handled with the Keptn Bridge.
205205
At sequence execution, if the approval task is reached, a panel is shown in all relevant screens:
206206

207207
In the environment view a pending approval can be recognized by the blue service out-of-sync icon at the according stage.
@@ -225,7 +225,7 @@ caption="Approval in Sequences">}}
225225

226226
### Manage projects
227227

228-
See the documentation for [managing projects](https://keptn.sh/docs/0.10.x/reference/bridge/manage_projects) to see which features for creating and updating projects the Bridge provides.
228+
See the documentation for [managing projects](https://v1.keptn.sh/docs/0.10.x/reference/bridge/manage_projects) to see which features for creating and updating projects the Bridge provides.
229229

230230
## Early access version of Keptn Bridge
231231

content/docs/0.10.x/reference/bridge/manage_projects/index.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ The following sections explain in detail which functionalities you can use to se
1010

1111
This may also be interesting for you:
1212

13-
* [Create a project with the CLI](https://keptn.sh/docs/0.10.x/reference/cli/commands/keptn_create_project/)
14-
* [Update a project with the CLI](https://keptn.sh/docs/0.10.x/reference/cli/commands/keptn_update_project/)
13+
* [Create a project with the CLI](https://v1.keptn.sh/docs/0.10.x/reference/cli/commands/keptn_create_project/)
14+
* [Update a project with the CLI](https://v1.keptn.sh/docs/0.10.x/reference/cli/commands/keptn_update_project/)
1515

1616
## Create a new project in Bridge
1717

@@ -37,11 +37,11 @@ The project name has to be unique in the Keptn installation. Therefore, it must
3737

3838
#### Git repository settings
3939
The Git upstream can be set by providing the Git repository URL, Git username and the Git token. This is parallel to the Git ``--git-user=GIT_USER --git-token=GIT_TOKEN --git-remote-url=GIT_REMOTE_URL`` parameters when using the Keptn CLI.
40-
More information about how you can set up your git provider can be found in the [Git-based upstream documentation](https://keptn.sh/docs/0.10.x/manage/git_upstream/).
40+
More information about how you can set up your git provider can be found in the [Git-based upstream documentation](https://v1.keptn.sh/docs/0.10.x/manage/git_upstream/).
4141

4242
#### Shipyard file
4343
Please provide the `shipyard.yaml` file here for your project. You can either drag it into the panel or select it manually from your file system with the "Select a file" button.<br/>
44-
You can find more information about the shipyard file on the [Shipyard documentation page](https://keptn.sh/docs/0.10.x/manage/shipyard/).
44+
You can find more information about the shipyard file on the [Shipyard documentation page](https://v1.keptn.sh/docs/0.10.x/manage/shipyard/).
4545

4646
After the successful creation of the project, you are redirected directly to the new project's settings page.
4747
Your project should already be available in the project overview and in the navigation.
@@ -71,5 +71,5 @@ caption="Delete project">}}
7171

7272
### Update the Git upstream settings
7373
The git upstream can be updated by providing the Git repository URL, Git username and the Git token. This can also be achieved by
74-
using the [keptn update project](https://keptn.sh/docs/0.10.x/reference/cli/commands/keptn_update_project/) command.
75-
More information about how you can set up your Git provider can be found in the [Git-based upstream documentation](https://keptn.sh/docs/0.10.x/manage/git_upstream/).
74+
using the [keptn update project](https://v1.keptn.sh/docs/0.10.x/reference/cli/commands/keptn_update_project/) command.
75+
More information about how you can set up your Git provider can be found in the [Git-based upstream documentation](https://v1.keptn.sh/docs/0.10.x/manage/git_upstream/).

content/docs/0.10.x/reference/bridge/manage_services/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The following sections explain in detail, which functionalities you can use to s
1010

1111
This may also be interesting for you:
1212

13-
* [Create a service with the CLI](https://keptn.sh/docs/0.10.x/reference/cli/commands/keptn_create_service/)
13+
* [Create a service with the CLI](https://v1.keptn.sh/docs/0.10.x/reference/cli/commands/keptn_create_service/)
1414

1515
## Create a service in Bridge
1616
On the service settings page, you can find a "Create service" button.

content/docs/0.10.x/reference/cli/commands/keptn_configure_monitoring.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Configures a monitoring provider
1212
Configure a monitoring solution for the deployments managed by Keptn.
1313

1414
**Note:** If you are executing *keptn configure monitoring dynatrace*, the service flag is optional since Keptn automatically detects the services of a project.
15-
See https://keptn.sh/docs/0.10.x/monitoring/dynatrace/install/ for more information.
15+
See https://v1.keptn.sh/docs/0.10.x/monitoring/dynatrace/install/ for more information.
1616

1717

1818
```

content/docs/0.10.x/reference/cli/commands/keptn_create_project.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The shipyard file describes the used stages. These stages are defined by name, a
1515
By executing the *create project* command, Keptn initializes an internal Git repository that is used to maintain all project-related resources.
1616
To upstream this internal Git repository to a remote repository, the Git user (*--git-user*), an access token (*--git-token*), and the remote URL (*--git-remote-url*) are required.
1717

18-
For more information about Shipyard, creating projects, or upstream repositories, please go to [Manage Keptn](https://keptn.sh/docs/0.10.x/manage/)
18+
For more information about Shipyard, creating projects, or upstream repositories, please go to [Manage Keptn](https://v1.keptn.sh/docs/0.10.x/manage/)
1919

2020

2121
```

content/docs/0.10.x/reference/cli/commands/keptn_delete_project.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Deletes a project identified by project name.
1515
* If a Git upstream is configured for this project, the referenced upstream repository (e.g., on GitHub) will not be deleted.
1616
* Services that have been deployed to the Kubernetes cluster are not deleted.
1717
* Namespaces that have been created on the Kubernetes cluster are not deleted.
18-
* Helm-releases created for deployments are not deleted. To clean-up deployed Helm releases, please see [Clean-up after deleting a project](https://keptn.sh/docs/0.10.x/continuous_delivery/deployment_helm/#clean-up-after-deleting-a-project)
18+
* Helm-releases created for deployments are not deleted. To clean-up deployed Helm releases, please see [Clean-up after deleting a project](https://v1.keptn.sh/docs/0.10.x/continuous_delivery/deployment_helm/#clean-up-after-deleting-a-project)
1919

2020

2121
```

content/docs/0.10.x/reference/cli/commands/keptn_generate_docs.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Generates the markdown documentation for the Keptn CLI
1111

1212
Generates markdown documentation for the Keptn CLI.
1313

14-
This command can be used to create an up-to-date documentation of the Keptn CLI and as published on: https://keptn.sh/docs
14+
This command can be used to create an up-to-date documentation of the Keptn CLI and as published on: https://v1.keptn.sh/docs
1515

1616
It creates one markdown file per command, suitable for rendering in Hugo.
1717

content/docs/0.10.x/reference/cli/commands/keptn_install.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Installs Keptn on a Kubernetes cluster
1111

1212
The Keptn CLI allows installing Keptn on any Kubernetes derivative to which your kube config is pointing to, and on OpenShift.
1313

14-
For more information, please follow the installation guide [Install Keptn](https://keptn.sh/docs/0.10.x/operate/install/#install-keptn)
14+
For more information, please follow the installation guide [Install Keptn](https://v1.keptn.sh/docs/0.10.x/operate/install/#install-keptn)
1515

1616

1717
```

content/docs/0.10.x/reference/cli/commands/keptn_uninstall.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This command does *not* delete:
1717
* Prometheus monitoring
1818
* Any (third-party) service installed in addition to Keptn (e.g., notification-service, slackbot-service, ...)
1919

20-
Besides, deployed services and the configuration on the Git upstream (i.e., GitHub, GitLab, or Bitbucket) are not deleted. To clean-up created projects and services, please see [Delete a project](https://keptn.sh/docs/0.10.x/manage/project/#delete-a-project).
20+
Besides, deployed services and the configuration on the Git upstream (i.e., GitHub, GitLab, or Bitbucket) are not deleted. To clean-up created projects and services, please see [Delete a project](https://v1.keptn.sh/docs/0.10.x/manage/project/#delete-a-project).
2121

2222
**Note:** This command requires a *Kubernetes current context* pointing to the cluster where Keptn should get uninstalled from.
2323

content/docs/0.10.x/reference/cli/commands/keptn_update_project.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Updating a shipyard file is not possible.
1616
By executing the update project command, Keptn will add the provided upstream repository to the existing internal Git repository that is used to maintain all project-related resources.
1717
To upstream this internal Git repository to a remote repository, the Git user (--git-user), an access token (--git-token), and the remote URL (--git-remote-url) are required.
1818

19-
For more information about updating projects or upstream repositories, please go to [Manage Keptn](https://keptn.sh/docs/0.10.x/manage/)
19+
For more information about updating projects or upstream repositories, please go to [Manage Keptn](https://v1.keptn.sh/docs/0.10.x/manage/)
2020

2121

2222
```

content/docs/0.10.x/reference/cli/commands/keptn_upgrade.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Upgrades Keptn on a Kubernetes cluster and supports upgrading the shipyard of a
1111

1212
The Keptn CLI allows upgrading Keptn on any Kubernetes derivative to which your kube config is pointing to, and on OpenShift. Also, it supports upgrading the shipyard of an existing project to a new specification.
1313

14-
For more information, please follow the installation guide [Upgrade Keptn](https://keptn.sh/docs/0.10.x/operate/upgrade/)
14+
For more information, please follow the installation guide [Upgrade Keptn](https://v1.keptn.sh/docs/0.10.x/operate/upgrade/)
1515

1616

1717
```

content/docs/0.10.x/reference/cli/commands/keptn_upgrade_project.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ This command will upgrade the shipyard of the project to the specified version
1515

1616
By executing the update project command, Keptn will fetch the current shipyard.yaml file of the project and convert it to the version specified in the 'toVersion'' flag.
1717

18-
For more information about upgrading projects, go to [Manage Keptn](https://keptn.sh/docs/0.10.x/operate/upgrade)
18+
For more information about upgrading projects, go to [Manage Keptn](https://v1.keptn.sh/docs/0.10.x/operate/upgrade)
1919

2020

2121
```

0 commit comments

Comments
 (0)