documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Add related content to admin and install documentation

Open RishitModi opened this issue 3 weeks ago • 1 comments

Issue number

  • Contributes to #1973

Description

This pull request adds Related content sections to selected Plone 6 documentation pages to improve discoverability and navigation for readers. The following pages were updated:

  • docs/install/index.md
  • docs/admin-guide/run-plone.md
  • docs/admin-guide/configure-zope.md

Add screenshots or links to a preview of the changes

Preview for docs/install/index.md image

Preview for docs/admin-guide/run-plone.md image

Preview for docs/admin-guide/configure-zope.md image


📚 Documentation preview 📚: https://plone6--2013.org.readthedocs.build/

RishitModi avatar Dec 18 '25 13:12 RishitModi

Thanks for submitting your first pull request! You are awesome! :hugs:
If you haven't done so already, read Plone's Code of Conduct and Contribute to documentation, as this will greatly help the review process.
Welcome to the Plone community! :tada:

boring-cyborg[bot] avatar Dec 18 '25 13:12 boring-cyborg[bot]

Sorry about that. I’ve reverted the unrelated formatting changes and fixed the rendering issues. Please let me know if anything else needs adjustment.

RishitModi avatar Jan 02 '26 14:01 RishitModi

Actually, none of these sections are needed. The pages are mostly just indices to other content. This doesn't actually help. I'll update the original issue to explicitly state that any Related content links must be actually related to the page content and lead the reader to the next step.

stevepiercy avatar Jan 02 '26 22:01 stevepiercy

Apologies for the mistake. I understand now that the added links were redundant with existing content, that explanatory text should not be included with links, and that these pages function purely as index pages where Related content sections are not needed. I also understand that any Related content must be strictly relevant, non-duplicative, and guide the reader to a clear next step.

RishitModi avatar Jan 03 '26 08:01 RishitModi