Uploaded image for project: 'Project FiFo'
  1. FIFO-634

Clean up some of the documentation branches

    Details

    • Type: Improvement
    • Status: Closed (View workflow)
    • Priority: Medium
    • Resolution: Won't Fix
    • Affects Version/s: None
    • Fix Version/s: 0.7.0
    • Component/s: documentation
    • Labels:

      Description

      I think we should clean up some of these documentation branches and only have what is really needed. This will make it simpler for people and remove some of the clutter.

      Currently there is:

      remotes/origin/0.6.0
      remotes/origin/0.6.1
      remotes/origin/HEAD -> origin/master
      remotes/origin/dang0ld-patch-1
      remotes/origin/master
      remotes/origin/raw
      remotes/origin/sphinx

      I think if possible would be good to keep it as :

      origin/master (This should be current release)
      origin/Development (This should be Dev)

      Alternatively, this structure could also makes sense if required, but just adds to the complexity and should be avoided if possible.

      origin/master (This should be current release)
      origin/0.6.0 (This should be 0.6.0 docs)
      origin/Development (This should be Dev)

      The most important aspect of this is to ensure that once users do a :

      git clone https://github.com/project-fifo/docs.git

      They are automatically working on the CURRENT RELEASE Branch and we should not expect them to default to "Dev" then have to do a "git branch -a" to see all the branches then try figure out which one is the correct current one, then do a "git checkout -b 0.6.1 origin/0.6.1" to get onto current branch.

      This restructure incidentally should fix the problem with the 401 Error for Readthedocs when a user clicks edit this page on github.

      Opinions please.

        Attachments

          Activity

            People

            • Assignee:
              heinz Heinz N. Gies
              Reporter:
              mark.slatem Mark Slatem
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: