Skip to content

Conversation

joestringer
Copy link
Member

Following the instructions here, remove the buttons to edit on github
since this is confusing for contributors since it opens PRs against
branches where we don't accept contributions, bypasses the standard
instructions like requiring signoffs, etc.

https://github.com/readthedocs/readthedocs.org/blob/master/docs/guides/remove-edit-buttons.rst

Following the instructions here, remove the buttons to edit on github
since this is confusing for contributors since it opens PRs against
branches where we don't accept contributions, bypasses the standard
instructions like requiring signoffs, etc.

https://github.com/readthedocs/readthedocs.org/blob/master/docs/guides/remove-edit-buttons.rst

Signed-off-by: Joe Stringer <joe@cilium.io>
@joestringer joestringer requested a review from a team as a code owner April 6, 2021 18:22
@joestringer joestringer requested a review from qmonnet April 6, 2021 18:22
@joestringer joestringer added needs-backport/1.7 release-note/misc This PR makes changes that have no direct user impact. labels Apr 6, 2021
@maintainer-s-little-helper maintainer-s-little-helper bot added dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. and removed dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. labels Apr 6, 2021
@joestringer
Copy link
Member Author

I didn't test this yet, I just prepared a PR following the instructions in the link. I figured it's probably easiest to just submit & merge and get RTD to build the new version to validate.

@qmonnet
Copy link
Member

qmonnet commented Apr 7, 2021

make -C Documentation live-preview is rather quick and works well to render.

Current documentation
pic1
With your PR
pic2

@qmonnet qmonnet added the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Apr 7, 2021
@pchaigno pchaigno added the area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. label Apr 7, 2021
@pchaigno pchaigno merged commit fe14fc9 into cilium:master Apr 7, 2021
This was referenced Apr 7, 2021
Copy link
Member

@aditighag aditighag left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Joe's and my commits look good. Err... Meant to post this on the backport PR. :)

@joestringer joestringer deleted the submit/hide-docs-edit-button branch April 7, 2021 16:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. ready-to-merge This PR has passed all tests and received consensus from code owners to merge. release-note/misc This PR makes changes that have no direct user impact.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants