Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • 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

...

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)

34http://wiki.tungsten.io

45.  https://tungsten.io 

5. https://tungstenfabric.github.io

...

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

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

...

  •       Y (should it go under Installation options???)

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

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

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)
    • tf-ansible-deployer
    • tf-ansible-internal
    • tf-ansible
    • tf-charms
    • tf-controller
    • tf-fabric-utils
    • tf-heat
    • tf-helm-deployer
    • tf-infra
    • tf-kolla-ansible
    • tf-packages
    • tf-project-config
    • tf-provisioning
    • tf-test
    • tf-third-party-packages
    • tf-tripleo-heat-templates
    • tf-vnc
    • tf-vrouter
    • tf-web-core

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

...

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)