Hi all,
Two PTGs ago, Ironic contributors had a topic about documentation -- we acknowledged our documentation was at times comprehensive, but at times incomprehensible :). This led us to enlist a professional technical writer, Dave Welsch, to assist.
Dave has been working over the last few months to get feedback from Ironic users and contributors, as well as auditing our documentation and has put his final findings here: https://docs.google.com/document/d/1e9URuPHKNTx5QXdkCFAzsS0EAAxPJ-xQC4BEpDwE... .
Actionable bugs were a desired outcome of this, which was achieved. We filed several bugs against Ironic, tagged "docs-audit-2024" -- you can see the list here: https://bugs.launchpad.net/ironic/+bugs?field.tag=docs-audit-2024.
I know that identifying issues is only part of the work needed; but it's our hope that by breaking this down and creating a path towards better docs, we'll be able to make it a less daunting task for contributors -- possibly even doable by folks from an outreachy-like program.
Thanks for those who participated in this process. Feel free to reach out here if you have any questions, or to me privately.
Thanks, Jay Faulkner