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 7 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
46 changes: 46 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,52 @@ Add "WIP" (Work in Progress) or "Draft" to the title if the PR is not yet ready
```console
git branch -d <branch-name>
```

## Choosing the correct branch when contributing

We are using Netlify to publish our pages.
We have staging and production levels for our documentation which are as follows:

1. Development documentation aka staging (build of `main` branch) - [link](https://main.lifecycle.keptn.sh)
2. Official documentation aka production (build of `page` branch) - [link](https://lifecycle.keptn.sh)
ShivangShandilya marked this conversation as resolved.
Show resolved Hide resolved

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

### Development documentation (Staging)
ShivangShandilya marked this conversation as resolved.
Show resolved Hide resolved

This page reflects the current development status of the documentation.
ShivangShandilya marked this conversation as resolved.
Show resolved Hide resolved
It will be built regularly and can be easily accessed.
ShivangShandilya marked this conversation as resolved.
Show resolved Hide resolved

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

It should allow bleeding-edge users and contributors to see the current state and help with debugging etc.
ShivangShandilya marked this conversation as resolved.
Show resolved Hide resolved

### Official documentation (Production)
ShivangShandilya marked this conversation as resolved.
Show resolved Hide resolved

This documentation set contains all released versions of KLT and is stored in an orphaned branch called `page`.
ShivangShandilya marked this conversation as resolved.
Show resolved Hide resolved

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

## FAQs

- Who/how do these changes get reviewed/approved/merged?
```
Like every normal PR - if the changes are approved by the maintainer, it will get merged.
```

- Which branch should I consider when contributing?
```
New writing goes to the main branch and can be viewed on the Releases -> development dropdown menu
```

- When we push the main branch to production, does it overwrite changes that were only pushed to page?
```
No, because a new version is generated - hence old page branch will be copied over a “version” folder
```
mowies marked this conversation as resolved.
Show resolved Hide resolved

### Developer Certification of Origin (DCO)

Expand Down