Page tree
Skip to end of metadata
Go to start of metadata

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


  • 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?)
  • Deployment (Q: should the deployment be a separate section or should it fall under Deep dive?)
  • Deep Dive / Development (should describe in detail how the things work, how to debug TF and how to develop it)
  • 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
          • Where you should put your 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
          • 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

2. Tungstenfabric/tf-transitional-contrail-docs/doc/release-notes     (already incorporated into tungstenfabric/docs)

3. Tungstenfabric/tf-transitional-contrail-docs/doc/getting-started-guide/    M (might be useful as legacy documentation but the newer version is mentioned in point 12)

4. http://wiki.tungsten.io

5. https://github.com/tungstenfabric/website (exposed on https://tungstenfabric.github.io)

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

https://github.com/tungstenfabric/tf-ansible-deployer     M (all below materials should be checked if they are valid for latest version or should they be archived)

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

9. https://contrail-api-cli.readthedocs.io       M (should be checked if it's valid for latest version or should they be archived)

10. https://www.juniper.net/documentation/en_US/contrail20/information-products/pathway-pages/api-guide-2005/index.html#      M (should be checked if it's valid for latest version or should they be archived)

11. Contrail Networking Architecture Guide

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

  • 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)















  • No labels