docs: Update Interacting with github section #1222
Conversation
YashPimple
requested review from
thisthat,
thschue,
bacherfl and
StackScribe
as code owners
github-actions
bot
added
the
documentation
|
Kudos, SonarCloud Quality Gate passed!
|
✅ Deploy Preview for keptn-lifecycle-toolkit ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
| * If you want to do the work on an issue, | ||
| include that information in your description of the issue | ||
| or in a comment to the issue. | ||
| ## [Guidelines for contributing](https://github.com/keptn/lifecycle-toolkit/tree/main/docs/content/en/docs/guidelines-for-contributing.md) |
There was a problem hiding this comment.
please do not put links in headlines
There was a problem hiding this comment.
Agree with Simon. Also, the file to which you are linking is in the main docs directory rather than in a directory under keptn.sh/contribute/ . The "Guidelines for contributing" should be under the general subdirectory. To verify that you have a file in the proper location, look at the netlify preview and click the "Contributing" tab on the top toolbar to be sure that the content is showing up there.
There was a problem hiding this comment.
Okay, you're getting closer but still a few big issues:
- This PR is smaller than the last but still includes work associated with two issues -- github and guidelines. As a general rule, we should have one PR per issue. Moreover, if you look at the github issue, you will see that someone else already submitted a PR for that so we don't need a second one. It would, of course, be good for you to review the other PR. Doing these small, targeted PRs makes it easier to review (some people can review the github piece; others can review the guidelines piece. This is kind of a core practice for both Agile development and open source and it really is tough to get used to. However, once you get used to it, I think you will see its advantages.
- Your source is located in the
docs/content/en/docsdirectory rather than in thedocs/content/en/contributedirectory. You should be building the docs locally and checking them then check them again on netlify after you submit the PR. I do not think that the contents of this PR show up on either build. You should see it when you click on the "Contributing" tab on the top of the page.
So let's turn this into a PR that is just for the "guidelines" with the source in the proper directory so we can view it. Also feel free to modify the content and add content. You are actually the target audience for much of this material so see if it makes sense and if it is complete and make any improvements you can.
Related to #972
Fixes issue #997
Signed-off-by: Yash Pimple [email protected]