plone / documentation

Plone Documentation
https://docs.plone.org
91 stars 153 forks source link

Two times a glossary? #1337

Closed jensens closed 2 years ago

jensens commented 2 years ago

Plone Documentation versions affected

Description

There is an overall glossary and one in in the restapi chapter. This is confusing and the restapi one should get merged into the main glossary.

stevepiercy commented 2 years ago

Just to clarify, we should keep both Glossaries, because restapi has its own separate build as a separate product. We should merge the Glossary entries from plone/plone.restapi into those of plone/documentation.

Then in the main docs, we should ignore the glossary.md in the plone/plone.restapi folder.

We should do the same for volto and plone.api.

stevepiercy commented 2 years ago

This was a little maddening to figure out, but it turns out to be simple.

In submodules/plone.restapi/docs/source/index.md:

- glossary
+ /glossary

In documentation/docs/conf.py, in the exclude_patterns list:

+    "plone.restapi/docs/source/glossary.md",  # There can be only one Glossary.

I verified builds in both restapi and main docs.