Stable Release of Developer Documentation at docs.systems.exact.engineering

Stable Release of Developer Documentation at docs.systems.exact.engineering#

  • Scope ID: 30

  • Owner: Charlie Winans

  • Duration: 10 Hours

  • Date: 10/28/2024

  • Due: 10/29/2024

  • Actual Completion Date: 11/23/2024

Overview#

Create the first stable release of the business plan including products, operations, and development features. This also includes the next development steps for the next release cycle.

Justification#

Up until now, development has focussed on having enough of a business plan for Exact Systems to encompass the development of products, the development of operations to deliver the products profitably, and the development of technology to do both in a consistent and efficient manner.

Deliverables#

  1. Clean up repository

  2. Ensure adequate scopes for the week of October 28, 2024 for Alex and Kyle

  3. Makefile updates to host production documentation site at docs.systems.exact.engineering from main branch

  4. Makefile updates to host development documentation site at docs.systems.exact.engineering/dev from dev branch

  5. Documentation site include additional operational role for systems administration to deploy docs.systems.exact.engineering

  6. Documentation site include scope summary produced by Python utility

  7. Scopes to ensure compeltion of Development Getting Started by Kyle

  8. Merge all scopes through scope 30 except for scopes 3, 4, and 5.

  9. Compile documentation including API docs and metacrud2 docstrings without errors.

  10. Production Getting Started Guide completion for industrial network project.

  11. Updated Makefile for creating production domain at systems.exact.engineering when on main branch

  12. Updated documentation site at docs.systems.exact.engineering

  13. Update the main getting started guide

  14. merge all scopes through scope 30 except for scopes 3, 4, and 5.

  15. Ensure no errors compiling documentation site

  16. Automate the development report at ./docs/Development/scopes/_index.csv

  17. Incorporate scripted documentation generation from ./docs/_utilities/_0_compile.py

  18. Publish new documentation site at docs.systems.exact.engineering from main branch

  19. Update scopes 31-34 and development schedule page

  20. Review documentation site with Kyle and Alex for usability

  21. Add a scope for Kyle to review documentation for completion and make a todo list under scope36 for me.

Resources#