docs: avoid generated content in git

scottchiefbaker / dool

Python3 compatible fork of dstat

GNU General Public License v3.0

332 stars 64 forks source link

docs: avoid generated content in git #37

Closed cpaelzer closed 1 year ago

cpaelzer commented 1 year ago

It is usually better to have a single source of truth (the .adoc) to avoid having outdated derivatives (like the current dool.1). Therefore let us not carry the generated content in git as it will rebuild as needed.

This comes after #28 and #30 are applied to complete the doc building.

ISSUE TYPE

Bugfix pull-request

DSTAT VERSION

Dool 1.1.0

SUMMARY

Avoid to ever use the potentially outdated dool.1 and also avoid to make doc changes to the wrong file.

scottchiefbaker commented 1 year ago

Apologies... Github was not sending me alerts for issues and pull requests on this repo. I did not see this until just now.

Is this still relevant? I'm working through some backlog.

scottchiefbaker commented 1 year ago

This should be addressed in 9b20ef0, which will automatically create the man page and html