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/
- https://docs.zephyrproject.org/latest/
- http://www.openmama.org/documentation
- https://docs.openvswitch.org/en/latest/
- https://helm.sh/docs/intro/using_helm/
- https://www.envoyproxy.io/docs/envoy/v1.15.0/intro/deprecated
- https://www.snas.io/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/re-written |
Quickstart | Done |
- About the documentation
- Quickstart / Getting started (alt names: Introduction) (Q: should we split it into two sections like Introduction that will explain TF and Getting started that will guide you through first installation steps?)
- What is Tungsten Fabric?
- What problems does it solve?
- New and Changed Features in this release
- <Feature name>
- Resolved issues in this release
- <JIRA TICKET ID> - <JIRA TICKET SUMMARY>
- Supported Platforms
- Known Behavior
- <JIRA TICKET ID> - <JIRA TICKET SUMMARY>
- Roadmap
- Architectural Overview (Q: should the Architectural Overview be a section under Getting started or should it be a section under Deep dive?)
- Use cases
- Blueprints (supersedes Roadmap?)
- Installation (Q: should the installation be a separate section or does it fall under Getting started?)
- Hardware requirements
- Download?
- Building source?
- Installation options:
- tf-devstack
- Ubuntu
- Centos
- other?
- Docker Env file parameters (based on https://www.juniper.net/documentation/en_US/release-independent/contrail/topics/reference/contrail-docker-env-parameters.pdf)
- Upgrade
- Deployment (Q: should the deployment be a separate section or should it fall under Deep dive?)
- User guides
- Configuring Virtual Networks
- Example of Deploying a Multi-Tier Web Application
- Configuring Services
- Configuring Service Chaining
- Adding Physical Network Functions in Service Chains
- Configuring High Availability
- Configuring Multitenancy Support
- Load Balancers
- API & CLI
- About Tungsten Fabric (alt names: Tungsten Fabric open source project, Community)
- Contributing to Tungsten Fabric
- Get in touch
- Contact channels
- Registration and user creation
- 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)
- Gerrit Guide
- Infrastructure Guide
- Integration Testing Guide
- Integration Distribution Guide
- Integration Packaging Guide
- Release Process Guide
- Documentation guide
- 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
- 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
- Building documentation
- Writing documentation
- Glossary
Existing documentation
(YMNW - Yes, Maybe, No, Write/Re-write)
- User Documentation
- Getting Started with Tungsten Fabric Y (move under Quickstart / Getting started)
- Getting Started with tf-devstack Y (move under Quickstart / Getting started)
- Tungsten Fabric 5.1 Release N (empty page)
- Release Notes: Tungsten Fabric 5.1 Y (move under Release Notes for the correct documentation branch/version)
- Table of Contents N (empty page)
- Introduction N (empty page)
- New and Changed Features Y
- Supported Platforms Tungsten Fabric 5.0 Y
- Known Behavior Y
- Resolved Issues Y
- Deprecated Items Y
- Requesting Technical Support N (contact will be covered by Get in touch)
- Release Notes: Tungsten Fabric 5.1 Y (move under Release Notes for the correct documentation branch/version)
- Tungsten Fabric 5.0.1 Release N (empty page)
- Getting Started with Tungsten Fabric 5.0.1 Y (move under Quickstart / Getting started for the correct documentation branch/version)
- Release Notes: Tungsten Fabric 5.0.1 Y (move under Release Notes for the correct documentation branch/version)
- Table of Contents N (empty page)
- Introduction N (empty page)
- New and Changed Features Y
- Supported Platforms Tungsten Fabric 5.0 Y
- Known Behavior Y
- Resolved Issues Y
- Deprecated Items Y
- Requesting Technical Support N (contact will be covered by Get in touch)
- Tungsten Fabric 5.0 Release N (empty page)
- Release Notes: Tungsten Fabric 5.0 Y (move under Release Notes for the correct documentation branch/version)
- Table of Contents N (empty page)
- Introduction N (empty page)
- New and Changed Features Y
- Supported Platforms Tungsten Fabric 5.0 Y
- Known Behavior Y
- Resolved Issues Y
- Deprecated Items Y
- Requesting Technical Support N (contact will be covered by Get in touch)
- Release Notes: Tungsten Fabric 5.0 Y (move under Release Notes for the correct documentation branch/version)
- Contribute to Tungsten Fabric N (empty page)
- Getting Started as a Contributor N (empty page)
- Getting Started as a Developer Y (move under Building the code)
- Processes before submitting a blueprint Y (move under Get in touch)
- Blueprint Submission Y (move under Get in touch)
- Code Submission Y (move under Get in touch)
- Test plan Submission Y (move under Get in touch)
- Tungsten Fabric JIRA workflow N (JIRA workflow is visible in the Jira itself, description of the task type is clear and PTL can always correct wrongly assigned type, workflow for Blueprints should be covered in Blueprint submission)
- How to review a patch in Gerrit Y (move under Building the code)
- Getting Started as a Contributor N (empty page)
- Infrastructure N (will be superseded by Infrastructure Guide)
- Administration N (will be superseded by Gerrit Guide, Integration Testing Guide, Integration Distribution Guide, Integration Packaging Guide)
- Tungsten Fabric Governance Y (will go to Wiki)
- Tungsten Fabric Architecture Review Board Y (will go to Wiki)
- ARB members Y (will go to Wiki)
- Tungsten Fabric Governance Working Group Y (will go to Wiki)
- Governance Resolutions Y (will go to Wiki)
- Community Committee Members Y (will go to Wiki)
- Tungsten Fabric Community Infrastructure Working Group Y (will go to Wiki)
- Tungsten Fabric Technical Steering Committee Working Group Y (will go to Wiki)
- Technical Steering Committee Working Group Resolutions Y (will go to Wiki)
- Technical Committee Members Y (will go to Wiki)
- Project Team Leads Y (will go to Wiki)
- Tungsten Fabric Architecture Review Board Y (will go to Wiki)
- Manual CLA Administration Y (will go to either Get in touch or Developer Documentation)
2. Tungstenfabric/tf-transitional-contrail-docs
Overview
Understanding Tungsten Fabric
Installing and Upgrading Tungsten Fabric
Server Requirements and Supported Platforms
Installing Tungsten Fabric and Provisioning Roles
Installation and Configuration Scenarios
Upgrading Tungsten Fabric Software
Contrail Command
Using Tungsten Fabric with Red Hat
Configuring Tungsten Fabric
Configuring Virtual Networks
Example of Deploying a Multi-Tier Web Application Using Tungsten Fabric
Configuring Services
Configuring Service Chaining
Examples: Configuring Service Chaining
Monitoring and Troubleshooting the Network Using Tungsten Fabric Analytics
Understanding Tungsten Fabric Analytics
Configuring Tungsten Fabric Analytics
Using Tungsten Fabric Analytics to Monitor and Troubleshoot the Network
- tf-transitional-contrail-docs/doc/release-notes/ N (already incorporated into tungstenfabric/docs)
- Glossary Abbreviations Definitions Y (move under Glossary)
5. https://tungstenfabric.github.io
- https://tungstenfabric.github.io/website/
- https://tungstenfabric.github.io/website/Carbide/CEG/docs/
- https://tungstenfabric.github.io/website/Carbide/CEG/docs/use_case_1
- https://tungstenfabric.github.io/website/Carbide/CEG/docs/use_case_2
- https://tungstenfabric.github.io/website/Carbide/CEG/docs/use_case_3
- https://tungstenfabric.github.io/website/Carbide/CEG/docs/use_case_4
- https://tungstenfabric.github.io/website/Tungsten-Fabric-15-minute-deployment-with-k8s-on-AWS.html
- https://tungstenfabric.github.io/website/Tungsten-Fabric-Centos-one-line-install-on-k8s.html
- https://tungstenfabric.github.io/website/Tungsten-Fabric-Ubuntu-one-line-install-on-k8s.html
- https://tungstenfabric.github.io/website/Tungsten-Fabric-Architecture.html
- https://tungstenfabric.github.io/website/L10N/Tungsten-Fabric-Architecture-CN.html
6. https://github.com/Juniper/contrail-controller/
- https://github.com/Juniper/contrail-controller/wiki/Kubernetes
- https://github.com/Juniper/contrail-controller/wiki/Install-K8s-using-Kubeadm
7. https://github.com/Juniper/contrail-ansible-deployer/
- https://github.com/Juniper/contrail-ansible-deployer/
- https://github.com/Juniper/contrail-ansible-deployer/wiki/Contrail-with-Openstack-Kolla N (already incorporated in the Wiki folder)
- https://github.com/Juniper/contrail-ansible-deployer/wiki/Debugging-contrail-code-in-contrail-microservice N (already incorporated in the Wiki folder)
8. https://github.com/tungstenfabric/tf-vnc
9. https://contrail-api-cli.readthedocs.io
10. Contrail Networking Architecture Guide
13. Release notes (https://www.juniper.net/documentation/en_US/contrail20/information-products/topic-collections/release-notes/jd0e23.html#jd0e23)
14. https://github.com/tonyliu0592/contrail/wiki/API-Configuration
15. https://github.com/tungstenfabric/docs-backup N (already incorporated into tungstenfabric/docs)
16. https://github.com/tungstenfabric/opencontrails-docs N (already incorporated into tungstenfabric/docs)
- doc N (already incorporated into tungstenfabric/docs)
- wiki N (already moved to tungstenfabric/docs but, later it will be reviewed and incorporated into documentation structure)
18. https://contrail-api-cli.readthedocs.io/en/latest/