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 

...

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

3Tungstenfabric/tf-transitional-contrail-docs/doc/getting-started-guide/

3. http://wiki.4. http://wiki.tungsten.io

...

5. https://tungstenfabric.github.io

...

com/

...

tungstenfabric

...

/website

...

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

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

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

...

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

10. Contrail Networking Architecture Guide 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

...

...

14. https://github.com/tonyliu0592/contrail/wiki/API-Configuration

...

15. https://github.com/tungstenfabric/docs-backup 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/

...