From 35e54378abbe1872d60254f73d54a947274aed38 Mon Sep 17 00:00:00 2001 From: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> Date: Mon, 21 Aug 2023 09:38:57 +0530 Subject: [PATCH 01/22] Update CONTRIBUTING.md Signed-off-by: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> --- docs/CONTRIBUTING.md | 49 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index ac3d9f1fa4..4fafa80f55 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -228,6 +228,55 @@ Add "WIP" (Work in Progress) or "Draft" to the title if the PR is not yet ready ```console git branch -d ``` + +## Publishing + +We are using Netlify to publish our pages. +There are 3 different types of publication: + +1. pull request previews +2. development documentation aka staging (build of `main` branch) - [link](https://main.lifecycle.keptn.sh) +3. official documentation aka production (build of `page` branch) - [link](https://lifecycle.keptn.sh) + +Within the navigation bar, we do have version links pointing to the different publications - if it makes sense. +For example, we are not linking from development and production to pull request previews. + +### Pull request preview + +- build: on each pull request with documentation changes +- build-environment: development +- config folder: [_default](./config/_default/) + +The pull request preview will be generated if documentation files have been touched - this is configured in the [netlify.toml](../netlify.toml). + +This preview should help contributors to inspect their changes within our usual page release. +Furthermore, it allows reviewers to inspect the rendered documentation without building it on their own. + +### Development page + +- build: on each push to `main` with documentation changes +- build-environment: main +- config folder: [main](./config/staging/) + +This page reflects the current development status of the documentation. +It will be built regularly and can be easily accessed. + +It should allow bleeding-edge users and contributors to see the current state and help with debugging etc. + +### Official documentation + +- build: on each push to `page` with documentation changes +- build-environment: production +- config folder: [production](./config/production/) + +This documentation set contains all released versions of KLT and is stored in an orphaned branch called `page`. + +Each version has its own `docs` folder named `docs-`. +Except for the latest version which will be within the `docs` folder. + +Each version-specific documentation contains a `version` file containing the version string. +This is important so we do know which version it contains - specifically important for `docs` of the latest version. + ### Developer Certification of Origin (DCO) From 121aad28fd42dbd18b12a12d69aead1ee6915d1e Mon Sep 17 00:00:00 2001 From: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> Date: Tue, 22 Aug 2023 10:48:33 +0530 Subject: [PATCH 02/22] Update docs/CONTRIBUTING.md Co-authored-by: Moritz Wiesinger Signed-off-by: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> --- docs/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 4fafa80f55..8c01ca30c1 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -238,7 +238,7 @@ There are 3 different types of publication: 2. development documentation aka staging (build of `main` branch) - [link](https://main.lifecycle.keptn.sh) 3. official documentation aka production (build of `page` branch) - [link](https://lifecycle.keptn.sh) -Within the navigation bar, we do have version links pointing to the different publications - if it makes sense. +Within the navigation bar, we have version links pointing to the different publications - if it makes sense. For example, we are not linking from development and production to pull request previews. ### Pull request preview From e40aa878d9878add09e02f70c2fa83fe8fa3253c Mon Sep 17 00:00:00 2001 From: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> Date: Wed, 23 Aug 2023 09:08:04 +0530 Subject: [PATCH 03/22] Update CONTRIBUTING.md Signed-off-by: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> --- docs/CONTRIBUTING.md | 40 ++++++++++------------------------------ 1 file changed, 10 insertions(+), 30 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 8c01ca30c1..1d37aeaa14 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -232,52 +232,32 @@ Add "WIP" (Work in Progress) or "Draft" to the title if the PR is not yet ready ## Publishing We are using Netlify to publish our pages. -There are 3 different types of publication: +We have staging and production levels in our documentation which are as follows: -1. pull request previews -2. development documentation aka staging (build of `main` branch) - [link](https://main.lifecycle.keptn.sh) -3. official documentation aka production (build of `page` branch) - [link](https://lifecycle.keptn.sh) +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) -Within the navigation bar, we have version links pointing to the different publications - if it makes sense. -For example, we are not linking from development and production to pull request previews. +Let's take a look what happens when your changes are merged in `main` and `page` branch respectively. -### Pull request preview +### Development documentation (Staging) -- build: on each pull request with documentation changes -- build-environment: development -- config folder: [_default](./config/_default/) - -The pull request preview will be generated if documentation files have been touched - this is configured in the [netlify.toml](../netlify.toml). - -This preview should help contributors to inspect their changes within our usual page release. -Furthermore, it allows reviewers to inspect the rendered documentation without building it on their own. - -### Development page +This page reflects the current development status of the documentation. +It will be built regularly and can be easily accessed. - build: on each push to `main` with documentation changes - build-environment: main - config folder: [main](./config/staging/) -This page reflects the current development status of the documentation. -It will be built regularly and can be easily accessed. - It should allow bleeding-edge users and contributors to see the current state and help with debugging etc. -### Official documentation +### Official documentation (Production) + +This documentation set contains all released versions of KLT and is stored in an orphaned branch called `page`. - build: on each push to `page` with documentation changes - build-environment: production - config folder: [production](./config/production/) -This documentation set contains all released versions of KLT and is stored in an orphaned branch called `page`. - -Each version has its own `docs` folder named `docs-`. -Except for the latest version which will be within the `docs` folder. - -Each version-specific documentation contains a `version` file containing the version string. -This is important so we do know which version it contains - specifically important for `docs` of the latest version. - - ### Developer Certification of Origin (DCO) Licensing is very important to open source projects. From 0c483e1ee222e35f17531017a328eb17f53529cc Mon Sep 17 00:00:00 2001 From: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> Date: Wed, 23 Aug 2023 09:19:56 +0530 Subject: [PATCH 04/22] Update CONTRIBUTING.md Signed-off-by: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> --- docs/CONTRIBUTING.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 1d37aeaa14..c754bf855c 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -229,10 +229,10 @@ Add "WIP" (Work in Progress) or "Draft" to the title if the PR is not yet ready git branch -d ``` -## Publishing +## Choosing the correct branch when contributing We are using Netlify to publish our pages. -We have staging and production levels in our documentation which are as follows: +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) @@ -258,6 +258,23 @@ This documentation set contains all released versions of KLT and is stored in an - build-environment: production - config folder: [production](./config/production/) +## FAQs + +- Who/how do these changes get reviewed/approved/merged? +``` +Like every normal PR - every maintainer has write permissions +``` + +- 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 +``` + ### Developer Certification of Origin (DCO) Licensing is very important to open source projects. From 142bd91346072c983eae28394305bbb522129af1 Mon Sep 17 00:00:00 2001 From: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> Date: Wed, 23 Aug 2023 09:26:22 +0530 Subject: [PATCH 05/22] Update CONTRIBUTING.md Signed-off-by: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> --- docs/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index c754bf855c..ed57a2b2ba 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -262,7 +262,7 @@ This documentation set contains all released versions of KLT and is stored in an - Who/how do these changes get reviewed/approved/merged? ``` -Like every normal PR - every maintainer has write permissions +Like every normal PR - if the changes are approved by the maintainer, it will get merged. ``` - Which branch should I consider when contributing? From 71ddf603475ce1387fe5511b2049f2c369e1d2d3 Mon Sep 17 00:00:00 2001 From: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> Date: Thu, 24 Aug 2023 11:37:29 +0530 Subject: [PATCH 06/22] Update CONTRIBUTING.md Signed-off-by: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> --- docs/CONTRIBUTING.md | 19 ++----------------- 1 file changed, 2 insertions(+), 17 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index ed57a2b2ba..e746c5fd87 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -231,7 +231,7 @@ Add "WIP" (Work in Progress) or "Draft" to the title if the PR is not yet ready ## Choosing the correct branch when contributing -We are using Netlify to publish our pages. +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: 1. Development documentation aka staging (build of `main` branch) - [link](https://main.lifecycle.keptn.sh) @@ -258,22 +258,7 @@ This documentation set contains all released versions of KLT and is stored in an - 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 -``` +A new version is generated when we push the `main` branch to production - hence old `page` branch will be copied over a “version” folder and it doesn't overwrite changes that were only pushed to `page`. ### Developer Certification of Origin (DCO) From 85e7578c51d29ff47fb8048887ba9160157c55f5 Mon Sep 17 00:00:00 2001 From: Moritz Wiesinger Date: Thu, 24 Aug 2023 14:44:42 +0200 Subject: [PATCH 07/22] fix markdown lint issues Signed-off-by: Moritz Wiesinger --- docs/CONTRIBUTING.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index e746c5fd87..fc46e17a7b 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -228,7 +228,7 @@ Add "WIP" (Work in Progress) or "Draft" to the title if the PR is not yet ready ```console git branch -d ``` - + ## Choosing the correct branch when contributing New writing goes to the `main` branch and can be viewed on the Releases -> development dropdown menu. @@ -244,9 +244,9 @@ Let's take a look what happens when your changes are merged in `main` and `page` This page reflects the current development status of the documentation. It will be built regularly and can be easily accessed. -- build: on each push to `main` with documentation changes -- build-environment: main -- config folder: [main](./config/staging/) +* 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. @@ -254,9 +254,9 @@ It should allow bleeding-edge users and contributors to see the current state an This documentation set contains all released versions of KLT and is stored in an orphaned branch called `page`. -- build: on each push to `page` with documentation changes -- build-environment: production -- config folder: [production](./config/production/) +* 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 - hence old `page` branch will be copied over a “version” folder and it doesn't overwrite changes that were only pushed to `page`. From 1229976843355bb390d95aaacc39e93dac56e547 Mon Sep 17 00:00:00 2001 From: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> Date: Thu, 24 Aug 2023 23:07:18 +0530 Subject: [PATCH 08/22] Update docs/CONTRIBUTING.md Co-authored-by: Moritz Wiesinger Signed-off-by: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> --- docs/CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index fc46e17a7b..86e42e36a5 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -258,7 +258,9 @@ This documentation set contains all released versions of KLT and is stored in an * build-environment: production * config folder: [production](./config/production/) -A new version is generated when we push the `main` branch to production - hence old `page` branch will be copied over a “version” folder and it doesn't overwrite changes that were only pushed to `page`. +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-` 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) From 0608c7ff05537d99a1d8f19669c0774741ac2952 Mon Sep 17 00:00:00 2001 From: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> Date: Sat, 9 Sep 2023 22:39:24 +0530 Subject: [PATCH 09/22] Update docs/CONTRIBUTING.md Co-authored-by: Meg McRoberts Signed-off-by: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> --- docs/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 4ad8d98e3a..feef276bbd 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -239,7 +239,7 @@ We have staging and production levels for our documentation which are as follows Let's take a look what happens when your changes are merged in `main` and `page` branch respectively. -### Development documentation (Staging) +## Development documentation (Staging) This page reflects the current development status of the documentation. It will be built regularly and can be easily accessed. From f2a5371d9e14da7316b2cd7fc8350acad57f126f Mon Sep 17 00:00:00 2001 From: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> Date: Sat, 9 Sep 2023 22:39:38 +0530 Subject: [PATCH 10/22] Update docs/CONTRIBUTING.md Co-authored-by: Meg McRoberts Signed-off-by: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> --- docs/CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index feef276bbd..6489d9182d 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -245,6 +245,7 @@ This page reflects the current development status of the documentation. It will be built regularly and can be easily accessed. * 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/) From 0b85673ec57403e6c0609dc3dfc10463c05f2f50 Mon Sep 17 00:00:00 2001 From: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> Date: Sat, 9 Sep 2023 22:39:47 +0530 Subject: [PATCH 11/22] Update docs/CONTRIBUTING.md Co-authored-by: Meg McRoberts Signed-off-by: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> --- docs/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 6489d9182d..2e91ae94ac 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -242,7 +242,7 @@ Let's take a look what happens when your changes are merged in `main` and `page` ## Development documentation (Staging) This page reflects the current development status of the documentation. -It will be built regularly and can be easily accessed. +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 From a0e8a1fc8279caed9b81514fd5b5360cf1dc96b0 Mon Sep 17 00:00:00 2001 From: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> Date: Sat, 9 Sep 2023 22:39:54 +0530 Subject: [PATCH 12/22] Update docs/CONTRIBUTING.md Co-authored-by: Meg McRoberts Signed-off-by: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> --- docs/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 2e91ae94ac..b411adf055 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -251,7 +251,7 @@ It is built regularly and can be easily accessed from the `Releases` tab on the It should allow bleeding-edge users and contributors to see the current state and help with debugging etc. -### Official documentation (Production) +## Latest -- Official documentation (Production) This documentation set contains all released versions of KLT and is stored in an orphaned branch called `page`. From e474b6a074b934e7fc5a66069e8c7409b2e2f12f Mon Sep 17 00:00:00 2001 From: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> Date: Sat, 9 Sep 2023 22:40:08 +0530 Subject: [PATCH 13/22] Update docs/CONTRIBUTING.md Co-authored-by: Meg McRoberts Signed-off-by: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> --- docs/CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index b411adf055..ac124f5ccf 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -241,7 +241,9 @@ Let's take a look what happens when your changes are merged in `main` and `page` ## Development documentation (Staging) -This page reflects the current development status of the documentation. +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 4649aed11c2d5fe8b6cc3db0cd8e2d34021150a5 Mon Sep 17 00:00:00 2001 From: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> Date: Sat, 9 Sep 2023 22:40:29 +0530 Subject: [PATCH 14/22] Update docs/CONTRIBUTING.md Co-authored-by: Giovanni Liva Signed-off-by: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> --- docs/CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index ac124f5ccf..62128aa188 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -262,7 +262,8 @@ This documentation set contains all released versions of KLT and is stored in an * 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-` folder and the new version will be pushed into the `docs` folder. +This means, that the content of the old version on the `page` branch will be copied over +to a `docs-` 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) From a83509f0dac7baba6cad690bd2733857d020bf0b Mon Sep 17 00:00:00 2001 From: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> Date: Sat, 9 Sep 2023 22:40:41 +0530 Subject: [PATCH 15/22] Update docs/CONTRIBUTING.md Co-authored-by: Meg McRoberts Signed-off-by: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> --- docs/CONTRIBUTING.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 62128aa188..411d2def6e 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -255,7 +255,15 @@ It should allow bleeding-edge users and contributors to see the current state an ## Latest -- Official documentation (Production) -This documentation set contains all released versions of KLT and is stored in an orphaned branch called `page`. +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. * build: on each push to `page` with documentation changes * build-environment: production From eb845c587ec3bc39bd63b01861f3e90ca2eb5e31 Mon Sep 17 00:00:00 2001 From: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> Date: Sat, 9 Sep 2023 22:40:53 +0530 Subject: [PATCH 16/22] Update docs/CONTRIBUTING.md Co-authored-by: Meg McRoberts Signed-off-by: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> --- docs/CONTRIBUTING.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 411d2def6e..db4192368d 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -251,7 +251,13 @@ It is built regularly and can be easily accessed from the `Releases` tab on the * 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. +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 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) From 36770e113a17694a5c50119543e8cc5a26fdd918 Mon Sep 17 00:00:00 2001 From: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> Date: Mon, 11 Sep 2023 18:26:32 +0530 Subject: [PATCH 17/22] Update docs/CONTRIBUTING.md Co-authored-by: Meg McRoberts Signed-off-by: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> --- docs/CONTRIBUTING.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index db4192368d..0c49316845 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -234,8 +234,18 @@ 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: -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) +* **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. From 29ff4c620de0d3b95539ac86946fd32cccee933b Mon Sep 17 00:00:00 2001 From: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> Date: Mon, 11 Sep 2023 18:46:02 +0530 Subject: [PATCH 18/22] Update CONTRIBUTING.md Signed-off-by: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> --- docs/CONTRIBUTING.md | 69 ++++++++++++++++++++++++-------------------- 1 file changed, 37 insertions(+), 32 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 0c49316845..500327f775 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -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-` 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. @@ -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-` 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) From f229cbb7f32de03932a65df10bdde7e417395ea8 Mon Sep 17 00:00:00 2001 From: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> Date: Fri, 29 Sep 2023 22:31:08 +0530 Subject: [PATCH 19/22] Update docs/CONTRIBUTING.md Co-authored-by: Rakshit Gondwal <98955085+rakshitgondwal@users.noreply.github.com> Signed-off-by: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> --- docs/CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 500327f775..77a517ad61 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -235,11 +235,11 @@ New writing goes to the `main` branch and can be viewed on the Releases -> devel 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): + * [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): + * [link](https://main.lifecycle.keptn.sh): This is the latest build of the `main` branch. * **Previous versions:** documentation for earlier releases. From 2dbb6a2c22914d7c2acdf278115cc18adcf4f308 Mon Sep 17 00:00:00 2001 From: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> Date: Fri, 29 Sep 2023 22:31:19 +0530 Subject: [PATCH 20/22] Update docs/CONTRIBUTING.md Co-authored-by: Rakshit Gondwal <98955085+rakshitgondwal@users.noreply.github.com> Signed-off-by: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> --- docs/CONTRIBUTING.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 77a517ad61..37ccd2c137 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -253,8 +253,10 @@ Let's take a look what happens when your changes are merged in `main` and `page` ## 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 +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 From 827e4f810069c72a0e3664073e7d774c209fe3b6 Mon Sep 17 00:00:00 2001 From: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> Date: Fri, 29 Sep 2023 22:31:29 +0530 Subject: [PATCH 21/22] Update docs/CONTRIBUTING.md Co-authored-by: Rakshit Gondwal <98955085+rakshitgondwal@users.noreply.github.com> Signed-off-by: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> --- docs/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 37ccd2c137..49c2fdafe0 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -260,7 +260,7 @@ 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. +remain valid across software and documentation updates. * build: on each push to `page` with documentation changes * build-environment: production From a1c8b9e1e3d9c64d41b5fbbe1e0954e27a112a18 Mon Sep 17 00:00:00 2001 From: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> Date: Fri, 29 Sep 2023 22:31:39 +0530 Subject: [PATCH 22/22] Update docs/CONTRIBUTING.md Co-authored-by: Rakshit Gondwal <98955085+rakshitgondwal@users.noreply.github.com> Signed-off-by: Shivang Shandilya <101946115+ShivangShandilya@users.noreply.github.com> --- docs/CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 49c2fdafe0..9b7c86dcdd 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -292,11 +292,11 @@ 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. +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.