Benchmark
- https://docs.readthedocs.io/en/stable/index.html
- https://pip.pypa.io/en/stable/
- https://docs.releng.linuxfoundation.org/en/latest/index.html
- https://docs.opendaylight.org/en/stable-magnesium/
- https://fd.io/docs/vpp/latest/troubleshooting/index.html
- https://docs.onap.org/en/latest/guides/onap-user/design/index.html
- http://pnda.io/guide
- https://github.com/open-switch/opx-docs/wiki
- http://www.contribution-guide.org
- https://www.postgresql.org/docs/
Constraints
- Tungsten Fabrics is an open source project. Everyone can contribute while following rules. Those rules need to be described.
- TF is a project under Linux Foundation. There needs to be a section describing what LF-networking is and what is the governance of the project.
- TF consists of modules. Modules might have their own documentation for installing, debugging, and development.
- TF has a GUI. There is a need for a user manual on how to use it.
- TF has dependencies on other software (for example orchestrators like Openstack or operating systems like Ubuntu). Those changes might have an impact on installation and deployment procedures. This means TF docs need versioning.
- TF has dependencies on other software (for example orchestrators like Openstack or operating systems like Ubuntu). Each release is compatible with different versions. Compatibility and supported platforms should be documented.
- Much of the project governance is done using wiki.tungsten.io. There should be clear guidance on what should go to docs and what should go to the wiki. Otherwise, it'll end with parallel maintenance (or worse — lack of maintenance).
New documentation tree
Legend:
Color | Status |
---|---|
Quickstart | Not yet analyzed |
Quickstart | Waiting to be written down |
Quickstart | Written |
- Quickstart / Getting started
- Installation
- Deployment
- About Tungsten Fabric
- Contributing to Tungsten Fabric
- Get in touch
- Contributing to the development
- Contributing to the documentation
- Submitting bugs
- Submitting blueprints
- Triaging tickets (how to work with JIRA)
- Developer documentation (These are guides and helpful documentation to running your own local version of TF for development)
- Building documentation
- Installing software (sphinx and tox)
- Getting the code (Full example of GitHub workflow.)
- Signed off
- easyCLA
- More reading: here
- Running linter
- Building
- Updating the docs.tungsten.io
- Writing documentation
- Principles of documentation
- The Brand
- Rst basics (based on this)
- Sections
- Text Formatting
- Inline markup and special characters (e.g., bold, italic, verbatim)
- Headings
- Internal and External Links
- List and bullets
- Images
- Documentation versioning
- Updating current version
- Writing for an unreleased version
- Releasing new version
- More reading: here and here
Existing documentation
(YMNW - Yes, Maybe, No, Write/Re-write)
- User Documentation
- Contribute to Tungsten Fabric
- Infrastructure
- Administration
- Tungsten Fabric Governance
- Manual CLA Administration
2. Tungstenfabric/tf-transitional-contrail-docs