search

bird-house / birdhouse-deploy

Scripts and configurations to deploy the various birds and servers required for a full-fledged production platform
https://birdhouse-deploy.readthedocs.io/en/latest/
Apache License 2.0
4 stars 7 forks source link

:books: [Documentation]: Improve descriptions of all components (including those that are/were in config/) #400

Open mishaschwartz opened 1 year ago

mishaschwartz commented 1 year ago

Description

After the migration of the components in the config/ directory to the components/ directory, we should add descriptions of all new and existing components in the components/ directory to components/README.rst.

First discussed here: https://github.com/bird-house/birdhouse-deploy/pull/399#discussion_r1387155509 Requires that #399 be pulled in first (or can be included in #399) if necessary.

References

Information Value
Server/Platform URL
Related issues/PR
Related documentation
mishaschwartz commented 11 months ago

Very basic descriptions were added in #399 but we should improve on them at a later date.

mishaschwartz commented 11 months ago

Suggestion from: https://github.com/bird-house/birdhouse-deploy/pull/399#issuecomment-1848074680

Future updates should probably reorganize them slightly so they are sorted similarly to the components directory. A TOC would also be useful since there are quite a lot in there now.