Volto docs are getting better

pigeonflight · February 24, 2024, 5:02pm

I know there have been concerns about the docs in the past. I'm observing steady improvement overtime and would like to mention it.

I'm really appreciating the Volto development recipes for example this developer recipe for calling images is great!

pigeonflight · June 9, 2024, 3:02am

and then the Volto development recipes page disappeared

stevepiercy · June 9, 2024, 8:02am

Thanks for the report.

This was part of a reorganization of the docs in Improve wayfinding for various Volto audiences by stevepiercy · Pull Request #5809 · plone/volto · GitHub, and is now located under Development.

Issue to correct the problem:

github.com/plone/documentation

Add redirect of `recipes` to `development`

opened 08:00AM - 09 Jun 24 UTC

stevepiercy

### Links of affected pages in Plone Documentation, if any. As part of the re…organization of docs in Volto in https://github.com/plone/volto/pull/5809, I neglected to include a redirect of the folder to the new location. Example: https://6.docs.plone.org/volto/recipes/widget.html#restricting-potential-targets Should be: https://6.docs.plone.org/volto/development/widget.html#restricting-potential-targets ### Description ```nginx location ~ ^/volto/recipes/(.*) { return 301 /volto/development/$1; } ``` Ref: https://community.plone.org/t/volto-docs-are-getting-better/18907

@polyester

pigeonflight · June 9, 2024, 12:15pm

so what was "recipes" is now "development" and there will be a redirect in the near future then?
Thanks @stevepiercy

pigeonflight · June 9, 2024, 12:29pm

@stevepiercy I know it's really simple but should something like the item below (how to configure a redirect) be added to that Development section?

stevepiercy · June 9, 2024, 2:13pm

Yes. Pull request appreciated.

Often stuff that is "obvious" or "just known" never gets documented by those who have gone through it before, which makes it difficult for those who have not gone through it yet.

There are dozens of these types of things in an open issue that also need to get added to the documentation.

pigeonflight · June 9, 2024, 11:22pm

done:

github.com/plone/volto

added entry on redirect after logout

plone:main ← plone:pigeonflight-redirect-after-logout

opened 11:22PM - 09 Jun 24 UTC

pigeonflight

+33 -0

This pull request documents the process of customizing the logout functionality …in Volto to automatically redirect users to the login page after they log out. By default, Volto does not redirect users to the login page after logging out, which can be confusing for users who expect to be taken back to the login page. ---- 📚 Documentation preview 📚: https://volto--6086.org.readthedocs.build/

pigeonflight · June 11, 2024, 11:27am

Almost there...
Just one tiny error on my pull request (looks like I need to add my new entry to a table of contents)

document isn't included in any toctree

[173](https://github.com/plone/volto/actions/runs/9464589703/job/26072229649?pr=6086#step:6:174)/home/runner/work/volto/volto/docs/source/news/6081.bugfix: WARNING: document isn't included in any toctree

These are useful CI prerequisites!!!

stevepiercy · June 11, 2024, 12:29pm

That's a mere warning that you can ignore, per Documentation – Frontend – Contributing to Volto — Plone Documentation v6.0.

The rest of that page provides make commands that you can run locally before pushing commits to ensure your Volto documentation contribution will satisfy CI.

We've also migrated to build pull request previews from Netlify to Read the Docs, so reviewers can visit the docs and review them without checking out your branch and building the docs locally using the latest Plone Sphinx Them (soon to be applied to main docs). Look here:

I presented this video on World Plone Day about all the latest stuff in Plone documentation that you can use now.