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

doc checklist for PRs requires reviewing the docs in Netlify #3192

Open
2 tasks
StackScribe opened this issue Mar 6, 2024 · 2 comments
Open
2 tasks

doc checklist for PRs requires reviewing the docs in Netlify #3192

StackScribe opened this issue Mar 6, 2024 · 2 comments
Labels
chore Maintenance documentation Improvements or additions to documentation good first issue Good for newcomers status: in-progress

Comments

@StackScribe
Copy link
Contributor

StackScribe commented Mar 6, 2024

Summary

The checklist for documentation PRs includes an item to read the docs with Netlify rather than readthedocs

Details

We now build the docs with MkDocs and the preview is done with ReadTheDocs. rather than Netlify.
https://keptn.sh/latest/docs/contribute/docs/local-building/ discusses how to run MkDocs locally.

The Check PR build section should also mention this and explain how to find the doc preview, since it isn't instantly obvious. The last item in the list of "Checks" performed on the PR is docs/readthedocs.org:keptn — Read the Docs build succeeded!. If you right-click on the Details link next to that item, you get a preview of the Keptn web page including the documentation build that includes the changes made in your PR. I suggest a paragraph after the bullet list that says something like:

"You should also review any documentation changes you made in the preview to ensure that the formatting is correct and all links and cross-references are working. To do this, find the docs/readthedocs.org:keptn — Read the Docs build succeeded! item in the list of checks performed; it is usually the last item. Right-click on the Details link next to that item to open a preview of the Keptn page that includes your modifications to the documentation."

DoD

  • Checklist here is updated to reference ReadTheDocs for preview instead of Netlify
  • Check PR includes a note that one should review the preview of docs changes and explain how to find the preview.
@mowies mowies added documentation Improvements or additions to documentation chore Maintenance status: ready-for-refinement Issue is relevant for the next backlog refinment labels Mar 6, 2024
@odubajDT odubajDT removed the status: ready-for-refinement Issue is relevant for the next backlog refinment label Mar 20, 2024
@RealAnna RealAnna added the good first issue Good for newcomers label Mar 20, 2024
@StackScribe
Copy link
Contributor Author

Abhay Raj is working on this

@mowies
Copy link
Member

mowies commented Apr 10, 2024

if possible, please tag them here, so that we can assign the issue :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Maintenance documentation Improvements or additions to documentation good first issue Good for newcomers status: in-progress
Projects
None yet
Development

No branches or pull requests

4 participants