Improve wayfinding for various Volto audiences #5809
Conversation
✅ Deploy Preview for volto ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for plone-components canceled.
|
|
https://github.com/plone/volto/actions/runs/8082176684/job/22082399377?pr=5809#step:4:224 will be fixed after this PR is merged and deployed to the main documentation. It can be safely ignored. |
…mary navigation items
stevepiercy
requested review from
davisagli,
sneridagh and
tiberiuichim
and removed request for
davisagli and
sneridagh
|
@stevepiercy I think I like better how fast the "other learning resources" were presented in the current docs as opposed to how it is now towards the end of the table of contents. I don't have a good suggestion here as I would have to look in more depth on how the tutorials were instructed from the trainings, then what we have and then to give more targeted suggestions. |
|
Check the linked issue to get @tiberiuichim's intent for "Developer Roadmap", renamed to "Overview". I tried to preserve this intent. This PR is also intended as another step toward Diátaxis, hence the creation of a new section for Learning/Tutorials. Because learning does not target a specific developers/integrators audience, it does not belong under Development. In addition, Development is more of a How-To Guides collection. From our Matomo website statistics, I got two interesting reports (see below). From that data, people who want to perform a specific development task in Volto is the largest segment. Thus the reordering of the navigation items is to better serve that purpose. Note that GSoC is one of the largest referrers to Volto docs, which skews the "contributing" section popularity. The most popular entry sections in Volto docs are, in order, the following.
The most popular sections of Volto docs that are visited after performing a search are, in order, the following.
|
There was a problem hiding this comment.
@stevepiercy This reorganization looks like a helpful step to me!
|
I'd really like @tiberiuichim's review on this pull request, as he was the creator of the original roadmap. I also would like @sneridagh's review, as a primary maintainer. For convenience, preview links for the significant changes (most changes are fixing cross-references and moving files):
|
|
Thank you, everyone! |
* main: (46 commits) Removed word-break:break-word from contents table tbody (#5749) Fix Link to Item and Aliases view not updating content in multilingua… (#5821) Fix HMR problems, upgrade react-refresh and @pmmmwh/react-refresh-web… (#5833) Uses Plone 6.0.10.1 in tests (#5830) Improve wayfinding for various Volto audiences (#5809) Fix issue with HMR and register the same predicate-less component again (#5832) Reset global Form state onSubmit and onCancel in Add and Edit forms. (#5827) Show validation error message as string instead of list (#5808) Updated build-deps command to check if registry is newer than dist to force rebuild (#5825) Upgrade TSQ to latest, testing deployments (#5824) Release 18.0.0-alpha.16 Release @plone/slate 18.0.0-alpha.9 Release @plone/scripts 3.4.0 Release @plone/registry 1.5.1 Release generate-volto 9.0.0-alpha.8 Release @plone/components 2.0.0-alpha.4 Release @plone/client 1.0.0-alpha.13 Several dependencies updates to 18 (#5815) [components] Pass down the Popover context, if any, in Select (#5823) [Components] Improve build, get rid of lodash, renaming Views directory, deps cleaning, upgrade StoryBook and Vite (#5822) ...
This link is outdated after #5809, and its anchor never existed. This PR corrects both issues.
Closes #5730
See also plone/documentation#1630