documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Fix Github button 'suggest edit' (at least for non-submodule docs)

Open ksuess opened this issue 3 years ago • 8 comments

ksuess avatar Apr 06 '22 09:04 ksuess

@ksuess thanks for creating this Pull Request and helping to improve Plone!

TL;DR: Finish pushing changes, pass all other checks, then paste a comment:

@jenkins-plone-org please run jobs

To ensure that these changes do not break other parts of Plone, the Plone test suite matrix needs to pass, but it takes 30-60 min. Other CI checks are usually much faster and the Plone Jenkins resources are limited, so when done pushing changes and all other checks pass either start all Jenkins PR jobs yourself, or simply add the comment above in this PR to start all the jobs automatically.

Happy hacking!

mister-roboto avatar Apr 06 '22 09:04 mister-roboto

Deploy Preview for 6-dev-docs-plone-org ready!

Name Link
Latest commit 9cb2f13779d632b07f1ed601451afd342bb34f91
Latest deploy log https://app.netlify.com/sites/6-dev-docs-plone-org/deploys/624d578bc360600007cfd36b
Deploy Preview https://deploy-preview-1221--6-dev-docs-plone-org.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

netlify[bot] avatar Apr 06 '22 09:04 netlify[bot]

Fixing the "suggest edit" link for submodule docs would mean a massive interference in sphinx-book-theme https://github.com/executablebooks/sphinx-book-theme/blob/526956165f3fda3e5faaf53ffc39081715702f6d/src/sphinx_book_theme/header_buttons/init.py#L94-L102

I tend to just hide the link for submodule pages (Volto, plone.restapi, plone.api) via CSS.

ksuess avatar Apr 06 '22 09:04 ksuess

What do you think of using JavaScript to rewrite the URL for non-main documentation to https://6.dev-docs.plone.org/contributing/index.html ?

Actually, I think I would prefer to use that link site-wide than "suggest an edit" for each page. I don't want to raise expectations of people making "drive by" pull requests without signing the Plone Contributor Agreement. This would direct them toward the authoritative method to submit a PR.

stevepiercy avatar Apr 06 '22 10:04 stevepiercy

What do you think of using JavaScript to rewrite the URL for non-main documentation to https://6.dev-docs.plone.org/contributing/index.html ?

Actually, I think I would prefer to use that link site-wide than "suggest an edit" for each page. I don't want to raise expectations of people making "drive by" pull requests without signing the Plone Contributor Agreement. This would direct them toward the authoritative method to submit a PR.

Yes, I completly aggree. 👍

ksuess avatar Apr 06 '22 11:04 ksuess

See https://github.com/plone/documentation/issues/1211

stevepiercy avatar Apr 07 '22 07:04 stevepiercy

What do you think of using JavaScript to rewrite the URL for non-main documentation to https://6.dev-docs.plone.org/contributing/index.html ?

Actually, I think I would prefer to use that link site-wide than "suggest an edit" for each page. I don't want to raise expectations of people making "drive by" pull requests without signing the Plone Contributor Agreement. This would direct them toward the authoritative method to submit a PR.

For the docs it is not required to sign the controbutor aggrement as far as i know. With that in mind, i would prefer a direct link to update docs, not just to a document.

MrTango avatar Apr 13 '22 06:04 MrTango

For the docs it is not required to sign the controbutor aggrement as far as i know.

See https://6.dev-docs.plone.org/contributing/index.html#granting-permission-to-publish as established by https://docs.plone.org/about/license.html.

With that in mind, i would prefer a direct link to update docs, not just to a document.

I would, too. However with the complexity of importing submodules from three other repos, this is not easy.

stevepiercy avatar Apr 13 '22 09:04 stevepiercy

GitHub link for "suggest edit" overridden for this repo: Impede drive-by edits by linking chapter on how to contribute. Fixed in https://github.com/plone/documentation/pull/1292

ksuess avatar Sep 06 '22 06:09 ksuess