Versions Compared

Key

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

...

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

...