In order to fix https://github.com/geosolutions-it/MapStore2/issues/10655 we need to update a chart in the documentation.
In the past, to support PDF export, a solution found was to convert all the charts, written in mermaid language (language widely supported by github, mkdocs and many other applications) in images.
This makes the documentation a lot less maintainable and reduces a lot the effeicency of creting them or updating.
For this reason, with this PR I restored the original charts code, and coverted the images using mkdocs-kroki-plugin. A plugin should that transformas mermaid charts into images.
The plugin above is base on Kroki that is a free service online, that provides also the possibility of self hosting services, whenever needed.
In the PR I:
Included the kroki plugin
Added some custom CSS to render properly the charts, without overflowing the pages
Fixed position of the acon in note/warning sections
documented better the library installation for mkdocs, using the virtual env, and properly adding to .gitignore the folders generated by these commands
some minor typo fixes in mkdocs and improved doc.
Things to do:
[x] Test real documentation (not only PDF)
[x] Properly style pdf to set max-height of charts
[x] Get back old mermaid charts syntax
[x] Update the chart for auth.md with refresh token request
Note. This could be valid also for 2024.02.01, because it specifies the effective behavior even before the PR on geostrore mentioned in #10655
Please check if the PR fulfills these requirements
Description
In order to fix https://github.com/geosolutions-it/MapStore2/issues/10655 we need to update a chart in the documentation. In the past, to support PDF export, a solution found was to convert all the charts, written in mermaid language (language widely supported by github, mkdocs and many other applications) in images. This makes the documentation a lot less maintainable and reduces a lot the effeicency of creting them or updating. For this reason, with this PR I restored the original charts code, and coverted the images using mkdocs-kroki-plugin. A plugin should that transformas mermaid charts into images.
The plugin above is base on Kroki that is a free service online, that provides also the possibility of self hosting services, whenever needed.
In the PR I:
.gitignorethe folders generated by these commandsThings to do:
auth.mdwith refresh token requestNote. This could be valid also for 2024.02.01, because it specifies the effective behavior even before the PR on geostrore mentioned in #10655
Please check if the PR fulfills these requirements
What kind of change does this PR introduce? (check one with "x", remove the others)
Issue
What is the current behavior?
What is the new behavior?
Breaking change
Does this PR introduce a breaking change? (check one with "x", remove the other)
Other useful information