Features

[NicolasMassart]

Here is a first set of features for this doctools.action-builder (checked ones are already implemented):

• provide common templates for doc sites.
• provide a Docker image to remove the need to install anything else than Docker to build and preview a doc.
• handle all the dependencies in the Docker image.
• provide common Github actions to be used by doc sites.
  • deploy latest version.
  • deploy released version.
  • test the doc.
    • lint code.
    • test links.
    • test the writing against guidelines.
    • test code samples.
• remove the need for a submodule as it was the case in our previous system.
• enable always up to date CI and template.
• have defaults behaviour that enable writers to preview without having to provide any parameters to the image.
• provide configuration default with .env overrides.
• provide Docker Compose file for local preview.
• implement Github Toolkit Problem matchers in actions
• Macros and filters
• Pluglets

Please suggest features in this conversation!

[NicolasMassart]

List of things that would be good to be flexible:

• Announcement -> Make it optional and active only if in mkdocs.yml
• Versioning -> VERSION_SWITCH=true/false in .env
• Language -> only if languages list in mkdocs.yml length > 1
• Front page HTML -> add new home template
• Color scheme (10+ sites with the same color could be confusing for the user) -> add CSS extra + override theme palette scheme
• extra css and JS without overwriting existing ones
• add footer 2em margin-top
• Optional docstools versioning to avoid updates breaking the build. Add image version in .env
• only one Footer/header colour.
• configurable page margins depending on content type

[NicolasMassart]

• Authentication (with logout link) using Okta for internal and other for external
• Externalised preview system (allow MkDocs insider version) using AWS.
• Swagger UI plugin
• Easier plugin configuration (maybe choice at doc level and not at Docker image level)