You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

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:

ColorStatus
QuickstartNot yet analyzed
QuickstartWaiting to be written down
QuickstartWritten


  • Quickstart / Getting started
  • Installation
  • Deployment
  • About Tungsten Fabric
    • Contributing to Tungsten Fabric
    •     Get in touch
      • 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)
      • Building the code
      • Building the 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
      • Writing documentation
        • Principles of documentation
        • The Brand
        • What goes into the docs.tungsten.io and what goes into the wiki
        • 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

Existing documentation

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

1. tungstenfabric/docs

2. Tungstenfabric/tf-transitional-contrail-docs

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











  • No labels