geoschem / geos-chem-cloud

Run GEOS-Chem easily on AWS cloud
http://cloud.geos-chem.org
MIT License
39 stars 9 forks source link

[FEATURE REQUEST] Keep documentation up-to-date and easier to maintain #32

Open JiaweiZhuang opened 4 years ago

JiaweiZhuang commented 4 years ago

Problem

With every version update, part of the readthedocs documentation will become out-of-date or even misleading (e.g. #31, https://github.com/geoschem/geos-chem-cloud/commit/831121d83412cfea7da8f21d19e06535f0f127d7)

All version-specific contents are vulnerable to such problem. For example:

Suggestions

  1. Collect a list of all version-dependent contents, and remember to update them at each version release.
  2. Minimize those version-dependent contents. Remove unnecessary pages.
  3. Go through to entire documentation with a certain schedule, such as every 3-month, or every major release (13.0.0, 14.0.0). Try if all commands still work. Remove outdated & misleading & unnecessary contents.
  4. Make use of readthedoc versioning so that users can fall back to old docs if the latest one has any problems.
  5. Explore other best practices for maintaining docs -- for example I found this Sphinx tutorial: Keeping Documentation Up to Date. The same practice is also useful for GCPy.
yantosca commented 1 year ago

We realize the documentation as of now (Dec 2022) may be out of date. We are looking into best practices as to how the documentation can be updated.