Welcome to BMI devdocs
This website hosts documentation for Badger Meter Inc. (BMI) software projects. It includes explanations, tutorials, and how-to guides as well as reference material that is automatically generated from source code. Its primary target audience is the BMI software development community.
Website Structure
The material is organized by GitHub repository. The documentation for each repository is located at the relative path:
/gh/<repo-name>
For example, the documentation for the sandbox repo
is located at:
/gh/sandbox
The documentation for each project should follow the Diátaxis framework. This framework recommends providing the following types of material:
- Learning: Tutorials
- Goals: How-To Guides
- Understanding: Explanation
- Information: Reference
Status
This website is being developed under the auspices of the
BMI Knowledge Management Initiative.
It is being developed by the Python Documentation Generation
Workgroup (Slack channelpython-doc-gen).
The initial focus of the workgroup is Python projects
hosted in the
badger-meter
organization at GitHub.
The source code for these pages is temporarily hosted in the GitHub sandbox repo.
This website is generated from Markdown source using the MkDocs site generator. For full documentation of MkDocs visit mkdocs.org.
This website is served from the AWS S3 bmi-devdocs-staging
in the Staging environment.