Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Signed-off-by: Shivang Shandilya <[email protected]>
  • Loading branch information
ShivangShandilya authored Sep 11, 2023
1 parent 36770e1 commit 29ff4c6
Showing 1 changed file with 37 additions and 32 deletions.
69 changes: 37 additions & 32 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -234,21 +234,41 @@ Add "WIP" (Work in Progress) or "Draft" to the title if the PR is not yet ready
New writing goes to the `main` branch and can be viewed on the Releases -> development dropdown menu.
We have staging and production levels for our documentation which are as follows:

* **latest:** official documentation of the current Keptn release
- [link](https://lifecycle.keptn.sh).
* **Latest:** official documentation of the current Keptn release
- [link](https://lifecycle.keptn.sh):
This is the build of the `page` branch.

* **development:** documentation being staged for the next Keptn release
- [link](https://main.lifecycle.keptn.sh).
* **Development:** documentation being staged for the next Keptn release
- [link](https://main.lifecycle.keptn.sh):
This is the latest build of the `main` branch.
* **previous versions:** documentation for earlier releases.
These are listed at
[link](https://github.com/keptn/lifecycle-toolkit/tree/page/docs/content/en).
* **contribute:** current version of the "Contribute" guide

* **Previous versions:** documentation for earlier releases.
These are listed at [link](https://github.com/keptn/lifecycle-toolkit/tree/page/docs/content/en).

* **Contribute:** current version of the "Contribute" guide
that is available from a tab on the documentation site.

Let's take a look what happens when your changes are merged in `main` and `page` branch respectively.

## Latest -- Official documentation (Production)

This set of documentation pertains to the latest KLT release and resides within an
isolated branch known as `page`. When a new version of KLT is launched, the contents of the `development`
branch are rolled into this branch. Additionally, it's important to recognize that any
document changes made using the "Edit this page" feature are seamlessly integrated into this branch.

This uses the `latest` label so that links to a doc page
remain valid across software and documentation updates.

* build: on each push to `page` with documentation changes
* build-environment: production
* config folder: [production](./config/production/)

A new version is generated when we push the `main` branch to production to release a new version of the docs page.
This means, that the content of the old version on the `page` branch will be copied over
to a `docs-<version>` folder and the new version will be pushed into the `docs` folder.
This way, no changes or older versions get overwritten.

## Development documentation (Staging)

This page contains the documentation being staged for the next Keptn release.
Expand All @@ -261,34 +281,19 @@ It is built regularly and can be easily accessed from the `Releases` tab on the
* build-environment: main
* config folder: [main](./config/staging/)

This is the staged version of the documentation for the next Keptn release.
PRs generated from a user's local branch, from the github editor, or from codespaces
are merged into this branch.
This version represents the pre-release iteration of the documentation for the upcoming Keptn release.
Pull requests originating from a user's local branch, the GitHub editor, or codespaces are merged into this branch.

This branch is promoted to `latest` when a new Keptn version is released.
On rare occasions, a PR that contains critical improvements to the documentation
may be silently promoted to `latest` without a software release.

## Latest -- Official documentation (Production)
When a new Keptn version is officially launched, this branch is elevated to the status of `latest`.
In exceptional cases, a pull request that includes vital documentation enhancements may be discreetly
advanced to `latest` without the need for a software release.

This documentation set contains documentation for the current KLT release
and is stored in an orphaned branch called `page`.
When a new KLT version is released,
the content of the `development` branch is rolled to this branch.
Note also that doc modifications made through the
"Edit this page" facility are merged directly into this branch.

This uses the `latest` label so that links to a doc page
remain valid across software and documentation updates.
## Previous Versions

* build: on each push to `page` with documentation changes
* build-environment: production
* config folder: [production](./config/production/)
Keptn documentation is versioned. By default, the version for the current Keptn release
is displayed on the documentation page but users can select other versions from the Releases tab.
The previous versions of the Keptn Documentation are available [here](https://github.com/keptn/lifecycle-toolkit/tree/page/docs/content/en).

A new version is generated when we push the `main` branch to production to release a new version of the docs page.
This means, that the content of the old version on the `page` branch will be copied over
to a `docs-<version>` folder and the new version will be pushed into the `docs` folder.
This way, no changes or older versions get overwritten.

### Developer Certification of Origin (DCO)

Expand Down

0 comments on commit 29ff4c6

Please sign in to comment.