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

Commit

Permalink
docs: move urls to new website (#1660)
Browse files Browse the repository at this point in the history
Signed-off-by: Giovanni Liva <giovanni.liva@dynatrace.com>
  • Loading branch information
thisthat authored Dec 7, 2023
1 parent 62baebf commit 9aaaef3
Show file tree
Hide file tree
Showing 166 changed files with 252 additions and 298 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
contact_links:
- name: Discuss on Slack
url: "https://keptn.sh/community/#slack"
url: "https://v1.keptn.sh/community/#slack"
about: You can discuss Keptn website in the keptn-website and keptn-docs channels on Keptn Slack
2 changes: 1 addition & 1 deletion .github/workflows/auto-update.yml
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ jobs:
./dist/keptn generate docs --dir="$DOCS_PATH"
# Replaces All Occurences of version links with a relative path
find $DOCS_PATH -print -type f -name '*.md' -exec sed -i "s@https://keptn.sh/docs/[[:digit:]][^/]*/@${RELATIVE_PATH}@g" {} \;
find $DOCS_PATH -print -type f -name '*.md' -exec sed -i "s@https://v1.keptn.sh/docs/[[:digit:]][^/]*/@${RELATIVE_PATH}@g" {} \;
- name: Create Pull Request
uses: peter-evans/create-pull-request@v4
Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contribute to the Keptn website

This document provides information about contributing to the [Keptn documentation](https://keptn.sh/docs/), which is part of the [Keptn](https://keptn.sh) website.
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.

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

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).
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).
We were all new to this once and are happy to help you!

## Notes about markdown
Expand Down Expand Up @@ -209,7 +209,7 @@ When *grip* is installed, you can format the specified file locally by running t

## Source file structure

The source files for the [Keptn Documentation](https://keptn.sh/docs/) are stored under the *content/docs* directory in the repository.
The source files for the [Keptn Documentation](https://v1.keptn.sh/docs/) are stored under the *content/docs* directory in the repository.
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.

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.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Keptn Website

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

The Keptn project has a static website powered by [Hugo](https://gohugo.io/) and [Netlify](https://www.netlify.com/).
Expand Down
2 changes: 1 addition & 1 deletion _redirects
Original file line number Diff line number Diff line change
@@ -1 +1 @@
https://keptn.netlify.com/* https://keptn.sh/:splat 301!
https://keptn.netlify.com/* https://v1.keptn.sh/:splat 301!
6 changes: 3 additions & 3 deletions assets/js/scripts.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@ if (body.classList.contains('page-home')) {
logoIntro.classList.add('is-sticky');
logo.classList.add('is-sticky');
hamburgerInner.classList.add('is-sticky');
logoJS.src = 'https://keptn.sh/images/logo.svg';
logoJS.src = 'https://v1.keptn.sh/images/logo.svg';
}
} else {
header.classList.remove('is-sticky');
logoIntro.classList.remove('is-sticky');
logo.classList.remove('is-sticky');
hamburgerInner.classList.remove('is-sticky');
logoJS.src = 'https://keptn.sh/images/home/hero/keptn-logo-white.svg';
logoJS.src = 'https://v1.keptn.sh/images/home/hero/keptn-logo-white.svg';
}
});

Expand Down Expand Up @@ -55,7 +55,7 @@ if (body.classList.contains('page-home')) {
shuffle(randomLogoNumbers);
var counter = 0;
happyUserLogos.forEach(logo => {
logo.src = 'https://keptn.sh/images/home/happy-users/logos/logo-' + randomLogoNumbers[counter] + '.png';
logo.src = 'https://v1.keptn.sh/images/home/happy-users/logos/logo-' + randomLogoNumbers[counter] + '.png';
counter = ++counter;
});
});
Expand Down
2 changes: 1 addition & 1 deletion config.toml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# baseURL = "https://keptn.sh/"
# baseURL = "https://v1.keptn.sh/"
languageCode = "en-us"
title = "keptn | Cloud-native application life-cycle orchestration"
theme = "hugo-serif-theme"
Expand Down
6 changes: 1 addition & 5 deletions content/community/contributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,14 +47,10 @@ If you are interested, join the `#keptn-docs` channel on the Keptn Slack workspa

Major documentation areas:

* Documentation ([keptn.sh/docs](https://keptn.sh/docs/)) - extend and improve the documentation for Keptn
* Documentation ([keptn.sh/docs](https://v1.keptn.sh/docs/)) - extend and improve the documentation for Keptn
* [GitHub Repository](https://github.com/keptn/keptn.github.io/)
* [How to contribute?](https://github.com/keptn/keptn.github.io/blob/master/CONTRIBUTING.md)
* [Good First Issues](https://github.com/keptn/keptn.github.io/labels/good%20first%20issue)
* 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.
* [GitHub Repository](https://github.com/keptn/tutorials)
* [How to contribute?](https://github.com/keptn/tutorials/blob/master/CONTRIBUTING.md)
* [Good First Issues](https://github.com/keptn/tutorials/labels/good%20first%20issue)
* 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!
* [Keptn Examples](https://github.com/keptn/examples) - expand and document Keptn examples that can be used by end users
* Contributing guidelines
Expand Down
10 changes: 5 additions & 5 deletions content/docs/0.10.x/reference/bridge/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,13 +175,13 @@ You can find links to for different integration possibilities here. This makes i
integrations for different CI providers.

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,
and additional data is gathered from the client. For more information about this see https://keptn.sh/docs/0.10.x/reference/load_information/.
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/.

### Settings

#### Project settings
In the settings view the project settings can be edited.
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).
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).

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

#### Service settings
In this view, services can be created, updated and deleted.
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).
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).

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

### Approvals

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.
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.
At sequence execution, if the approval task is reached, a panel is shown in all relevant screens:

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

### Manage projects

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.
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.

## Early access version of Keptn Bridge

Expand Down
12 changes: 6 additions & 6 deletions content/docs/0.10.x/reference/bridge/manage_projects/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ The following sections explain in detail which functionalities you can use to se

This may also be interesting for you:

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

## Create a new project in Bridge

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

#### Git repository settings
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.
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/).
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/).

#### Shipyard file
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/>
You can find more information about the shipyard file on the [Shipyard documentation page](https://keptn.sh/docs/0.10.x/manage/shipyard/).
You can find more information about the shipyard file on the [Shipyard documentation page](https://v1.keptn.sh/docs/0.10.x/manage/shipyard/).

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

### Update the Git upstream settings
The git upstream can be updated by providing the Git repository URL, Git username and the Git token. This can also be achieved by
using the [keptn update project](https://keptn.sh/docs/0.10.x/reference/cli/commands/keptn_update_project/) command.
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/).
using the [keptn update project](https://v1.keptn.sh/docs/0.10.x/reference/cli/commands/keptn_update_project/) command.
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/).
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The following sections explain in detail, which functionalities you can use to s

This may also be interesting for you:

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

## Create a service in Bridge
On the service settings page, you can find a "Create service" button.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Configures a monitoring provider
Configure a monitoring solution for the deployments managed by Keptn.

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


```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The shipyard file describes the used stages. These stages are defined by name, a
By executing the *create project* command, Keptn initializes an internal Git repository that is used to maintain all project-related resources.
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.

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


```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Deletes a project identified by project name.
* If a Git upstream is configured for this project, the referenced upstream repository (e.g., on GitHub) will not be deleted.
* Services that have been deployed to the Kubernetes cluster are not deleted.
* Namespaces that have been created on the Kubernetes cluster are not deleted.
* 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)
* 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)


```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Generates the markdown documentation for the Keptn CLI

Generates markdown documentation for the Keptn CLI.

This command can be used to create an up-to-date documentation of the Keptn CLI and as published on: https://keptn.sh/docs
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

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Installs Keptn on a Kubernetes cluster

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

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


```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This command does *not* delete:
* Prometheus monitoring
* Any (third-party) service installed in addition to Keptn (e.g., notification-service, slackbot-service, ...)

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).
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).

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Updating a shipyard file is not possible.
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.
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.

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


```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Upgrades Keptn on a Kubernetes cluster and supports upgrading the shipyard of a

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.

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


```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This command will upgrade the shipyard of the project to the specified version

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.

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


```
Expand Down
Loading

0 comments on commit 9aaaef3

Please sign in to comment.