oxd docs workflow

oxd docs workflow

The workflow applies not only to oxd docs, but all of the docs beings synced from github.

The $VERSION IS 2.4.4, 3.1.2, 3.1.3 etc. The $DOC can be oxd, ce, cm, supergluu etc.

so for $DOC with version $VERSION for example, we follow these steps:

• Create a directory: $VERSION

• Then we git initialize it with: git init

• Since, the checkout from the sub-directory i.e https://github.com/GluuFederation/docs-$DOC-prod/tree/$VERSION/$VERSION was necessary, so we need to do sparse checkout with:

  git remote add -f origin https://github.com/GluuFederation/docs-$DOC-prod
  git config core.sparseCheckout true
  echo "$VERSION/" >> .git/info/sparse-checkout
  

• Then we pull the branch as to get changes from the remote repo without comments.:

  env GIT_SSL_NO_VERIFY=true git pull --no-edit origin $VERSION
  

• Then we make docs as:

  /usr/local/bin/mkdocs build --clean
  

Example: $DOC=oxd and $VERSION=3.1.4 URL: https://github.com/GluuFederation/docs-oxd-prod/tree/3.1.4/3.1.4 is:

  mkdir 3.1.4
  git init
  git remote add -f origin https://github.com/GluuFederation/docs-oxd-prod
  git config core.sparseCheckout true
  echo "3.1.4/" >> .git/info/sparse-checkout
  env GIT_SSL_NO_VERIFY=true git pull --no-edit origin 3.1.4
  /usr/local/bin/mkdocs build --clean

So, if we change the structure of docs, we can simply repeat the procedure for all the docs. We only require the docs structure to be same for all the docs.