docs: update the general guidelines section

[YashPimple]

Related #972
Fixes #995

Signed-off-by: Yash Pimple [email protected]

[netlify]

✅ Deploy Preview for keptn-lifecycle-toolkit ready!

Name	Link
🔨 Latest commit	e518dc4
🔍 Latest deploy log	https://app.netlify.com/sites/keptn-lifecycle-toolkit/deploys/6454a7e3e6a60c0008c04df2
😎 Deploy Preview	https://deploy-preview-1377--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 settings.

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

[StackScribe]

Nice work, @YashPimple ! I apologize for the confusion about all this so let me try to clarify.

• The guidelines should be in the general section of the Contributing Guide rather than software because they apply to documentation as well as software
• The guidelines themselves should then be removed from both the lifecycle-toolkit/CONTRIBUTING.md file leaving just. the link.

The concept is that having a CONTRIBUTING.md file in the root of the repo is a convention but that file has become rather difficult to read. So we move the real content to the Contributing Guide but leave links to that guide in CONTRIBUTING.md.

We did have a separate CONTRIBUTING.md file for docs but I can't find that right now. And I'm not sure whether we need it with the docs and software in the same repo. A lot of the info duplicated material/topics that were also in the main CONTRIBUTING.md file . But we do need info about how to build the docs locally, markdown lint, the structure of the doc source files, et cetera. @aepfli has been doing some work in this general area -- perhaps he can explain and give guidance.

But we do not need to solve all of that for this PR. Please do the following:

• Move the guidelines list into the general directory
• Remove the guidelines list from the CONTRIBUTING.md file, leaving just the link as you have it.

With that, hopefully we can get this merged and you'll be an official contributor -- congratulations!

[YashPimple]

Thank you for the clarification, @StackScribe! I understand that the guidelines should be moved to the general section of the Contributing Guide, and removed from the lifecycle toolkit/CONTRIBUTING.md file, leaving only the link. I will make the necessary changes as requested.

Regarding the separate CONTRIBUTING.md file for docs, I will check with @aepfli for guidance on whether we need it or if the information can be consolidated into the main CONTRIBUTING.md file.
I will make the changes as requested and submit the updated PR for review.

[YashPimple]

@StackScribe I have made a New PR #1388 addressing the above comment.

[mowies]

Closed in favor of #1411