Skip to content

Conversation

@RishitModi
Copy link

@RishitModi RishitModi commented Dec 18, 2025

Issue number

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/

@boring-cyborg
Copy link

boring-cyborg bot commented Dec 18, 2025

Thanks for submitting your first pull request! You are awesome! 🤗

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! 🎉

Copy link
Contributor

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

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

Please revert any changes that are not directly related to the original issue. Reformatting was unnecessary, and many of the changes break the docs rendering.

@github-project-automation github-project-automation bot moved this from New to In Progress in Plone Documentation Dec 20, 2025
@RishitModi
Copy link
Author

RishitModi commented Jan 2, 2026

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

Copy link
Contributor

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

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

Remove all explanatory text from the links. Tooltips handle this already.

Comment on lines +73 to +76

```{seealso}
If you don't want to use Cookieplone as the recommended way to install Plone with Classic UI for a frontend, read {doc}`/conceptual-guides/compare-buildout-pip` to help inform your choice between Buildout and pip for an installation method.
```
Copy link
Contributor

Choose a reason for hiding this comment

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

This is duplicated from, and redundant to, the original immediate above, and doesn't help. Please remove.

Suggested change
```{seealso}
If you don't want to use Cookieplone as the recommended way to install Plone with Classic UI for a frontend, read {doc}`/conceptual-guides/compare-buildout-pip` to help inform your choice between Buildout and pip for an installation method.
```

@stevepiercy
Copy link
Contributor

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 stevepiercy closed this Jan 2, 2026
@github-project-automation github-project-automation bot moved this from In Progress to Done in Plone Documentation Jan 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants