Add "Related content" as the final section in most pages
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
Research direction
No repository file or test is named. Start by reviewing the documentation structure and identifying eligible non-index pages, then use the stated contribution requirements to select genuinely related destinations. Done means appropriate pages have a final Related content section with meaningful links, without changing index or landing pages.
Written by the indexing model from the issue text.
Description
As an example, the MS SQL docs have "Related content" as the final section in most of their pages.
I think something like this would be a nice enhancement for the future docs structure.
[!CAUTION]
Pull requests that don't meet the following requirements shall be immediately closed.
- The contributor should actually read and understand the content on both the page where they put the links and the destination pages of the links.
- Ensure that the content between pages or sections is truly related. I've already seen and closed many PRs that mindlessly match a single word.
- Not be on
index.mdpages. There's no content on index pages, so it's impossible for anything to be related to it. - Not be on pages that serve a similar function as index pages, such as a landing page that directs users to other pages.
Originally posted by @stevepiercy in https://github.com/plone/volto/pull/7360#discussion_r2367018720
- Dominant language
- Makefile
- Stars
- 106
- Forks
- 190
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 1
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from plone/documentation
-
Difficulty 1/5 Under an hour Newbie friendliness 62/100
plone/documentation#2077 · 1 comment ·
-
99 tag: sprint
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
plone/documentation#1336 · 9 comments ·
-
31 needs: help 41 lvl: easy 99 tag: good first issue 99 tag: hacktoberfest 99 tag: Plone 6.x dependencies
Difficulty 3/5 1-2 days Newbie friendliness 68/100
plone/documentation#2100 ·
-
plone/documentation#2076 · 1 assignee ·
-
33 needs: docs 41 lvl: easy 99 tag: good first issue 99 tag: hacktoberfest
Difficulty 3/5 1-2 days Newbie friendliness 55/100
plone/documentation#2065 · 8 comments · 1 reaction ·
All issues in plone/documentation
Similar issues
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
infinispan/infinispan#18150 ·