Uploaded image for project: 'Samza'
  1. Samza
  2. SAMZA-259

Restructure documentation folders

    XMLWordPrintableJSON

    Details

    • Type: Bug
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 0.6.0
    • Fix Version/s: 0.8.0
    • Component/s: docs
    • Labels:
      None

      Description

      Currently, we have hard-coded versions in the documentation path. When we bump versions we have to manually create a new subfolder called 0.8.0, and update all links to point to this version. A better approach is probably do what rust does: use branches to build multiple versions of documentation. We already have an 0.7.0 branch, and we've got master. This very much mirrors Rust's structure:

      http://static.rust-lang.org/doc/master/tutorial.html
      http://static.rust-lang.org/doc/0.10/tutorial.html

      This structure shouldn't change the paths in the website. All that it means is that we'll have:

      This is better for SEO, as well, since everyone will link to master, which will always reflect up-to-date information. With our current setup, everything that links to 0.7.0 will be outdated when we release docs with 0.8.0.

        Attachments

        1. SAMZA-259.patch
          3.52 MB
          Yan Fang
        2. SAMZA-259.1.patch
          2.28 MB
          Yan Fang
        3. SAMZA-259.2.patch
          4.55 MB
          Yan Fang
        4. SAMZA-259.2-0.7.0.patch
          1.01 MB
          Yan Fang
        5. SAMZA-259.3.patch
          4.55 MB
          Yan Fang
        6. SAMZA-259.3.0.7.0.patch
          1.01 MB
          Yan Fang
        7. SAMZA-259.4.patch
          4.55 MB
          Yan Fang

          Issue Links

            Activity

              People

              • Assignee:
                closeuris Yan Fang
                Reporter:
                criccomini Chris Riccomini
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: