doc checklist for PRs requires reviewing the docs in Netlify

[StackScribe]

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.

[StackScribe]

Abhay Raj is working on this

[mowies]

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