You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jan 11, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Contribute to the Keptn website
2
2
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.
4
4
5
5
This documentation is authored with [markdown](https://www.markdownguide.org/basic-syntax/)
6
6
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
11
11
You can also run the [Hugo](https://gohugo.io/) based website locally to check the rendered documentation
12
12
and then push your changes to the repository as a pull request.
13
13
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).
15
15
We were all new to this once and are happy to help you!
16
16
17
17
## Notes about markdown
@@ -209,7 +209,7 @@ When *grip* is installed, you can format the specified file locally by running t
209
209
210
210
## Source file structure
211
211
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.
213
213
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.
214
214
215
215
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.
*[How to contribute?](https://github.com/keptn/keptn.github.io/blob/master/CONTRIBUTING.md)
53
53
*[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.
*[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)
58
54
* 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!
59
55
*[Keptn Examples](https://github.com/keptn/examples) - expand and document Keptn examples that can be used by end users
Copy file name to clipboardExpand all lines: content/docs/0.10.x/reference/bridge/_index.md
+5-5
Original file line number
Diff line number
Diff line change
@@ -175,13 +175,13 @@ You can find links to for different integration possibilities here. This makes i
175
175
integrations for different CI providers.
176
176
177
177
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/.
179
179
180
180
### Settings
181
181
182
182
#### Project settings
183
183
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).
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).
194
194
195
195
{{< popup_image
196
196
link="./assets/service-settings.png"
@@ -201,7 +201,7 @@ caption="Keptn Bridge Service Settings View">}}
201
201
202
202
### Approvals
203
203
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.
205
205
At sequence execution, if the approval task is reached, a panel is shown in all relevant screens:
206
206
207
207
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">}}
225
225
226
226
### Manage projects
227
227
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.
Copy file name to clipboardExpand all lines: content/docs/0.10.x/reference/bridge/manage_projects/index.md
+6-6
Original file line number
Diff line number
Diff line change
@@ -10,8 +10,8 @@ The following sections explain in detail which functionalities you can use to se
10
10
11
11
This may also be interesting for you:
12
12
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/)
15
15
16
16
## Create a new project in Bridge
17
17
@@ -37,11 +37,11 @@ The project name has to be unique in the Keptn installation. Therefore, it must
37
37
38
38
#### Git repository settings
39
39
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/).
41
41
42
42
#### Shipyard file
43
43
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/).
45
45
46
46
After the successful creation of the project, you are redirected directly to the new project's settings page.
47
47
Your project should already be available in the project overview and in the navigation.
@@ -71,5 +71,5 @@ caption="Delete project">}}
71
71
72
72
### Update the Git upstream settings
73
73
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/).
Copy file name to clipboardExpand all lines: content/docs/0.10.x/reference/cli/commands/keptn_configure_monitoring.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ Configures a monitoring provider
12
12
Configure a monitoring solution for the deployments managed by Keptn.
13
13
14
14
**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.
Copy file name to clipboardExpand all lines: content/docs/0.10.x/reference/cli/commands/keptn_create_project.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ The shipyard file describes the used stages. These stages are defined by name, a
15
15
By executing the *create project* command, Keptn initializes an internal Git repository that is used to maintain all project-related resources.
16
16
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.
17
17
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/)
Copy file name to clipboardExpand all lines: content/docs/0.10.x/reference/cli/commands/keptn_delete_project.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ Deletes a project identified by project name.
15
15
* If a Git upstream is configured for this project, the referenced upstream repository (e.g., on GitHub) will not be deleted.
16
16
* Services that have been deployed to the Kubernetes cluster are not deleted.
17
17
* 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)
Copy file name to clipboardExpand all lines: content/docs/0.10.x/reference/cli/commands/keptn_uninstall.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ This command does *not* delete:
17
17
* Prometheus monitoring
18
18
* Any (third-party) service installed in addition to Keptn (e.g., notification-service, slackbot-service, ...)
19
19
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).
21
21
22
22
**Note:** This command requires a *Kubernetes current context* pointing to the cluster where Keptn should get uninstalled from.
Copy file name to clipboardExpand all lines: content/docs/0.10.x/reference/cli/commands/keptn_update_project.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ Updating a shipyard file is not possible.
16
16
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.
17
17
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.
18
18
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/)
Copy file name to clipboardExpand all lines: content/docs/0.10.x/reference/cli/commands/keptn_upgrade.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ Upgrades Keptn on a Kubernetes cluster and supports upgrading the shipyard of a
11
11
12
12
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.
13
13
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/)
Copy file name to clipboardExpand all lines: content/docs/0.10.x/reference/cli/commands/keptn_upgrade_project.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ This command will upgrade the shipyard of the project to the specified version
15
15
16
16
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.
17
17
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)
0 commit comments