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

Update training to Plone Conference 2024 #886

Merged
merged 1 commit into from
Nov 25, 2024
Merged

Update training to Plone Conference 2024 #886

merged 1 commit into from
Nov 25, 2024

Conversation

ericof
Copy link
Member

@ericof ericof commented Nov 25, 2024


📚 Documentation preview 📚: https://plone-training--886.org.readthedocs.build/

@ericof ericof merged commit 11fedad into main Nov 25, 2024
4 checks passed
@ericof ericof deleted the installing-2024 branch November 25, 2024 18:19
@stevepiercy
Copy link
Contributor

@ericof do you have the request/response diagram available as SVG or the source files you used to generate it? This would be a good Mermaid or Graphviz diagram for documentation.

@ericof
Copy link
Member Author

ericof commented Nov 27, 2024

@stevepiercy Do we support Mermaid in our docs? I did not have time to check it, so I generated the png

@stevepiercy
Copy link
Contributor

@ericof yes, the recent release of sphinxcontrib-mermaid 1.0.0 now makes it work with Plone Sphinx Theme 1.0.0.

You can see some examples at https://6.docs.plone.org/conceptual-guides/package-dependencies.html. @jensens used https://www.mermaidchart.com/play with a live preview, then copy-pasted it into the docs, and I did a little fine tuning so that lines show up in dark mode. See also the docs for usage at https://6.docs.plone.org/contributing/documentation/myst-reference.html#diagrams-and-graphs-with-mermaid.

I think this diagram would be good on a new page under https://6.docs.plone.org/conceptual-guides/index.html, as it would describe the concept of the request-reponse cycle in Plone.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants