Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: move docs branch sections from readme to contrib guide #1902

Merged
merged 26 commits into from
Oct 2, 2023
Merged
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
35e5437
Update CONTRIBUTING.md
ShivangShandilya Aug 21, 2023
121aad2
Update docs/CONTRIBUTING.md
ShivangShandilya Aug 22, 2023
4b017dc
Merge branch 'main' into docs-contributing
ShivangShandilya Aug 22, 2023
c9c3791
Merge branch 'main' into docs-contributing
ShivangShandilya Aug 23, 2023
e40aa87
Update CONTRIBUTING.md
ShivangShandilya Aug 23, 2023
0c483e1
Update CONTRIBUTING.md
ShivangShandilya Aug 23, 2023
142bd91
Update CONTRIBUTING.md
ShivangShandilya Aug 23, 2023
71ddf60
Update CONTRIBUTING.md
ShivangShandilya Aug 24, 2023
2a763d7
Merge branch 'main' into docs-contributing
ShivangShandilya Aug 24, 2023
85e7578
fix markdown lint issues
mowies Aug 24, 2023
1229976
Update docs/CONTRIBUTING.md
ShivangShandilya Aug 24, 2023
ba89b45
Merge branch 'main' into docs-contributing
ShivangShandilya Aug 26, 2023
0608c7f
Update docs/CONTRIBUTING.md
ShivangShandilya Sep 9, 2023
f2a5371
Update docs/CONTRIBUTING.md
ShivangShandilya Sep 9, 2023
0b85673
Update docs/CONTRIBUTING.md
ShivangShandilya Sep 9, 2023
a0e8a1f
Update docs/CONTRIBUTING.md
ShivangShandilya Sep 9, 2023
e474b6a
Update docs/CONTRIBUTING.md
ShivangShandilya Sep 9, 2023
4649aed
Update docs/CONTRIBUTING.md
ShivangShandilya Sep 9, 2023
a83509f
Update docs/CONTRIBUTING.md
ShivangShandilya Sep 9, 2023
eb845c5
Update docs/CONTRIBUTING.md
ShivangShandilya Sep 9, 2023
36770e1
Update docs/CONTRIBUTING.md
ShivangShandilya Sep 11, 2023
29ff4c6
Update CONTRIBUTING.md
ShivangShandilya Sep 11, 2023
f229cbb
Update docs/CONTRIBUTING.md
ShivangShandilya Sep 29, 2023
2dbb6a2
Update docs/CONTRIBUTING.md
ShivangShandilya Sep 29, 2023
827e4f8
Update docs/CONTRIBUTING.md
ShivangShandilya Sep 29, 2023
a1c8b9e
Update docs/CONTRIBUTING.md
ShivangShandilya Sep 29, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 69 additions & 1 deletion docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,75 @@ Add "WIP" (Work in Progress) or "Draft" to the title if the PR is not yet ready
git branch -d <branch-name>
```

## Developer Certification of Origin (DCO)
## Choosing the correct branch when contributing

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):
This is the build of the `page` branch.

* **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
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.
It contains information about new and changed features and functionality
as well as general documentation improvements.
It is built regularly and can be easily accessed from the `Releases` tab on the documentation site.

* build: on each push to `main` with documentation changes
from a user's local branch, from the github editor, or from codespaces
* build-environment: main
* config folder: [main](./config/staging/)

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.

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.

## Previous Versions

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

### Developer Certification of Origin (DCO)

All commits must be accompanied by a DCO sign-off.
See
Expand Down