Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve wayfinding for various Volto audiences #5809

Merged
merged 16 commits into from
Mar 4, 2024
Merged

Conversation

stevepiercy
Copy link
Collaborator

@stevepiercy stevepiercy commented Feb 28, 2024

Copy link

netlify bot commented Feb 28, 2024

Deploy Preview for volto ready!

Name Link
🔨 Latest commit a0b4416
🔍 Latest deploy log https://app.netlify.com/sites/volto/deploys/65e3ba09efa88c0008a57003
😎 Deploy Preview https://deploy-preview-5809--volto.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 configuration.

Copy link

netlify bot commented Feb 28, 2024

Deploy Preview for plone-components canceled.

Name Link
🔨 Latest commit a0b4416
🔍 Latest deploy log https://app.netlify.com/sites/plone-components/deploys/65e3ba09ff43e90008ac53ff

@stevepiercy
Copy link
Collaborator Author

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.

@stevepiercy stevepiercy marked this pull request as ready for review February 29, 2024 08:57
@stevepiercy stevepiercy requested review from davisagli, sneridagh and tiberiuichim and removed request for davisagli and sneridagh February 29, 2024 08:57
@stevepiercy stevepiercy self-assigned this Feb 29, 2024
@ichim-david
Copy link
Member

@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.
So I would add it after the Development -> Overview page.
I also don't know if it's good enough to rename the Recipes to Development and have this section first.
If it is then it should probably have some info structured better.

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.
Hopefully the others have better suggestions but this was my initial jab at saying something until I can have more suggestive comments.

@stevepiercy
Copy link
Collaborator Author

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.

  • contributing
  • /index.html
  • recipes
  • blocks
  • configuration
  • addons
  • user-manual
  • getting-started
  • client
  • deploying
  • release-notes
  • upgrade-guide
  • theming

The most popular sections of Volto docs that are visited after performing a search are, in order, the following.

  • contributing
  • recipes
  • addons
  • configuration
  • client
  • blocks
  • deploying
  • release-notes
  • upgrade-guide
  • theming
  • user-manual
  • getting-started

Copy link
Member

@davisagli davisagli left a comment

Choose a reason for hiding this comment

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

@stevepiercy This reorganization looks like a helpful step to me!

docs/source/index.md Outdated Show resolved Hide resolved
@stevepiercy
Copy link
Collaborator Author

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):

@stevepiercy
Copy link
Collaborator Author

Thank you, everyone!

@stevepiercy stevepiercy merged commit 8e08d5a into main Mar 4, 2024
63 of 65 checks passed
@stevepiercy stevepiercy deleted the 5730-reorg-roadmap branch March 4, 2024 22:40
sneridagh added a commit that referenced this pull request Mar 5, 2024
* 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)
  ...
stevepiercy added a commit that referenced this pull request Jun 9, 2024
This link is outdated after #5809, and its anchor never existed. This PR corrects both issues.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Status: Done
Development

Successfully merging this pull request may close these issues.

Delete Developer roadmap from docs?
5 participants