Publishing Uyuni docs to gh pages

Publishing Uyuni Docs

You must have already built the Uyuni docs. Copy the build directory to a different directory so you don’t accidentally delete it.

Procedure: Publishing Uyuni docs to gh-pages

1. Delete your current working copy of uyuni-docs out of your workspace.

2. Clone a fresh copy of the repo:

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

3. Change back into the uyuni-docs directory:

   cd uyuni-docs/

4. Check out the gh-pages branch:

   git checkout gh-pages

   If you check the contents of the directory now, you will see it doesn’t have the full repo contents, it only has the contents of a /build directory.

5. Check out a new branch called yyyy.mm-updates-username (or similar):

   git checkout -b 2020.06-updates-lbrindley

6. Copy the contents of the /build directory you saved locally into the uyuni-docs directory.

7. Make sure there is a .nojekyll file in the root of the branch. If there is not, create it: touch .nojekyll.

8. Commit the updated build files:

   git add .
   git commit -m "updated build files"
   git push --set-upstream origin 2020.06-updates-lbrindley

9. Go to the Github WebUI and create the PR. Ensure you compare back to gh-pages.

DO NOT MERGE THE PR. Julio will merge when he’s ready.