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/
  11. https://docs.zephyrproject.org/latest/
  12. http://www.openmama.org/documentation
  13. https://docs.openvswitch.org/en/latest/
  14. https://helm.sh/docs/intro/using_helm/
  15. https://www.envoyproxy.io/docs/envoy/v1.15.0/intro/deprecated
  16. https://www.snas.io/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:

ColorStatus
QuickstartNot yet analyzed
QuickstartWaiting to be written/re-written
QuickstartDone


Existing documentation

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

1. tungstenfabric/docs

2. Tungstenfabric/tf-transitional-contrail-docs



3. http://wiki.tungsten.io

4. https://tungsten.io 

5. https://tungstenfabric.github.io

6. https://github.com/Juniper/contrail-controller/

7. https://github.com/Juniper/contrail-ansible-deployer/

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

9. https://contrail-api-cli.readthedocs.io

10. Contrail Networking Architecture Guide

11. https://github.com/Juniper/contrail-ansible-deployer/wiki/Debugging-contrail-code-in-contrail-microservices

12. https://www.juniper.net/documentation/en_US/contrail5.0/topics/concept/overview-virtual-network-controller.html

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)

17. tungstenfabric/tf-old-docs

18. https://contrail-api-cli.readthedocs.io/en/latest/

19. https://www.juniper.net/documentation/en_US/contrail20/information-products/pathway-pages/api-guide-2005/index.html#