archivematica / Issues

Issues repository for the Archivematica project
GNU Affero General Public License v3.0
16 stars 1 forks source link

Problem: configuration docs are not generated automatically #1408

Open sevein opened 6 years ago

sevein commented 6 years ago

artefactual/archivematica#845 added a document (or documents, one per component) where the environment variables are listed. This work was done manually but it should be possible to update appconfig.py so it can output the full list as long as the details are included in the CONFIG_MAPPING. We could add a new method that outputs the list so it's later added to the Markdown file or we could even have the method to update the Markdown file dynamically and then commit it.

Other ideas that could be easily addressed once it's automated:

scollazo commented 6 years ago

We can also consider moving them to the root package folder (MCPServer/README.md instead of install/README.md )