TechDocs publishing and reading

TechDocs publishing and reading An architecture diagram generated by Archify. Developer · Documentation author · Architecture component Developer Documentation author Git repository · docs/ + mkdocs.yml · Architecture component Git repository docs/ + mkdocs.yml MkDocs build · CI job · Architecture component MkDocs build CI job S3 bucket · Private artifacts · Architecture component S3 bucket Private artifacts TechDocs UI · Documentation viewer · Architecture component TechDocs UI Documentation viewer TechDocs backend · Auth / S3 reader · Architecture component TechDocs backend Auth / S3 reader Markdown CI build publish artifacts read docs documents Legend Frontend Backend Cloud External

External builder

  • • Version docs and mkdocs.yml with code
  • • CI builds and publishes artifacts

S3 access

  • • Separate publisher and reader permissions
  • • Serve documents through the authenticated backend
  • • Keep the bucket private