Benchmark

1. https://docs.readthedocs.io/en/stable/index.html
2. https://pip.pypa.io/en/stable/
3. https://docs.releng.linuxfoundation.org/en/latest/index.html
4. https://docs.opendaylight.org/en/stable-magnesium/
5. https://fd.io/docs/vpp/latest/troubleshooting/index.html
6. https://docs.onap.org/en/latest/guides/onap-user/design/index.html
7. http://pnda.io/guide
8. https://github.com/open-switch/opx-docs/wiki
9. http://www.contribution-guide.org
10. https://www.postgresql.org/docs/

Constraints

1. Tungsten Fabrics is an open source project. Everyone can contribute while following rules. Those rules need to be described.
2. 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.
3. TF consists of modules. Modules might have their own documentation for installing, debugging, and development.
4. TF has a GUI. There is a need for a user manual on how to use it.
5. 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.  
6. 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.
7. 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:

• Quickstart / Getting started
  • Release notes
  • Supported platform
• Installation
• Deployment

• About Tungsten Fabric
  • 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
    • Updating current version
    • Writing for an unreleased version
    • Releasing new version
    • More reading: here and here
  • Building documentation
  • Writing documentation

• Glossary

Existing documentation

(YMNW - Yes, Maybe, No, Write/Re-write)

1. tungstenfabric/docs

• 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)
  • 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)
• 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)
• Infrastructure
• Administration
• Tungsten Fabric Governance
  • Tungsten Fabric Architecture Review Board
    • ARB members
  • Tungsten Fabric Governance Working Group
    • Governance Resolutions
    • Community Committee Members
  • Tungsten Fabric Community Infrastructure Working Group
  • Tungsten Fabric Technical Steering Committee Working Group
    • Technical Steering Committee Working Group Resolutions
    • Technical Committee Members
    • Project Team Leads
• Manual CLA Administration

2. Tungstenfabric/tf-transitional-contrail-docs

3. http://wiki.tungsten.io

4. https://tungsten.io 

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
• https://github.com/Juniper/contrail-ansible-deployer/wiki/Debugging-contrail-code-in-contrail-microservice

8. https://github.com/tungstenfabric/tf-vnc

• http://juniper.github.io/contrail-vnc/README.html