docs: move docs branch sections from readme to contrib guide

[ShivangShandilya]

This PR closes: #1863

This PR adds Publishing Section in our docs contributing guide as it gives a pretty good idea in what happens when things are merged in page and main branch.

[netlify]

✅ Deploy Preview for keptn-lifecycle-toolkit ready!

Name	Link
🔨 Latest commit	827e4f8
🔍 Latest deploy log	https://app.netlify.com/sites/keptn-lifecycle-toolkit/deploys/651702ec8216430008a36360
😎 Deploy Preview	https://deploy-preview-1902--keptn-lifecycle-toolkit.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[mowies]

This looks good in general, but please remove the copied sections from the readme and instead link to the newly created sections so that we don't have duplicated content. That should improve maintainability in the future.

[mowies]

Also, please run markdownlint-fix in the docs folder and fix any remaining markdown lint issues. You can find the list of issues in the failing PR check.

[ShivangShandilya]

Also, please run markdownlint-fix in the docs folder and fix any remaining markdown lint issues. You can find the list of issues in the failing PR check.

Shows no issues when running the command

[ShivangShandilya]

@mowies take a look at the new changes I made I have tried changing the content a bit so it doesn't look duplicated.
Also, I have added a new block (we can remove it if you don't like it) a FAQs block, I have taken ques from the community meeting docs and placed them over here.

Reason: I found these ques to answer queries that a new contributor might have when contributing to docs, we can further add ques if in future some new queries arise.
Result: A thorough read of the docs contributing guide should almost solve all the queries of the contributor

I was quite hesitant to make this change but I think its a good addition overall but I can remove it if you say otherwise 😅

[mowies]

LGTM, i would just put the FAQ content into the other sections

[mowies]

I suggested a slightly different version. See if you like it :)

[mowies]

@ShivangShandilya I fixed the markdownlint issues. If you apply my suggestion, also the last error should get fixed.

[StackScribe]

Also, please run markdownlint-fix in the docs folder and fix any remaining markdown lint issues. You can find the list of issues in the failing PR check.

Shows no issues when running the command

If make markdownlint-fix shows 0 errors, it means that it was able to correct all the issues it found, not that it did not find any issues.

[StackScribe]

This is a nice start but it is supposed to be in the "Documentation contributions" section of the "Contributing" guide that is accessed from the "Contributing" tab on the Keptn screen. To implement this:

1. Go to the docs/content/en/contribute/docs directory
2. Create a sub-directory with a meaningful name, perhaps versions
3. Create an _index.md file in that directory.
4. Add a header block to that index.md file. You can copy the header block from the file in the local-building/_index.md file. I suggest using a weight of 425. This locates it after the local-building page but close, which seems logical.

Add your text after this header block, with one blank line after the header box.

[StackScribe]

You need an introductory paragraph that begins with a good topic sentence. Something like "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 following are available:`

Then maybe use the first list you have, but I would put the Official Documentation first, followed by the Development branch, then add a third item for "Documentation for previous releases.

I'll comment your file further with some other suggestions. Do not slavishly follow my suggestions -- they have too much duplicated information. I think it's good information but you can decide where it goes. It may make sense to have the bullet list in the introduction be very brief: just "Latest", "Development", "Old versions", and "Contribute" then move all the details about each into the sections below.

[ShivangShandilya]

I'll just work on this ASAP, sorry for taking so long 🥲

[ShivangShandilya]

@StackScribe I have made some changes, please take a look.
I have gone along with the bullet list suggestion as I think it's a good one.
Also I have added the Previous Versions block after the Development block and also rephrased some of the documentation so that it doesn't look duplicated.
I think it looks much better than before but more suggestions are appreciated 😄

[RealAnna]

@ShivangShandilya this is 🚀 , if you fix the markdown errors we can merge this so everyone will finally know how to edit docs pages 👍

[rakshitgondwal]

These suggestions should help you with the markdownlint errors @ShivangShandilya

[ShivangShandilya]

These suggestions should help you with the markdownlint errors @ShivangShandilya

Thanks @rakshitgondwal for helping me out here 🚀

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

[mowies]

thanks for your contribution @ShivangShandilya !