Testing changes. Please ignore.
These are some really basic guidelines to get started.
Structure of this repo:
- Books go in a top level folder. For example: manage_quay.
- Each book folder has a symlink to the top level modules folder.
- A book's TOC is defined in the master.adoc file contained within the book's folder.
- master.adoc contains includes to modules (chapters) which are created in the top level modules folder.
- You will also need to define a docinfo.xml in the book's folder to contain basic information about a book.
To get started:
- Fork this repository
- git clone https://github.com/quay/quay-docs.git
- cd quay-docs
- git remote add git@github.com:/quay-docs.git
- git fetch --all
To contribute:
- git checkout master
- git checkout -b
- Edit files with changes
- git commit -a -m "description of changes"
- git push
- Visit https://github.com/quay/quay-docs and create pull-request against master
Once merge to master is done and you want to stage:
- git fetch origin
- git rebase origin/master
- git checkout stage
- git rebase origin/stage
- git cherry-pick
In the last step, you are cherry picking the commit id of your work in the master.
More instructions to follow once we have a full fledged product.
$ oc create -fhttps://raw.githubusercontent.com/tnozicka/openshift-acme/master/deploy/letsencrypt-live/single-namespace/{role,serviceaccount,imagestream,deployment}.yaml
$ oc policy add-role-to-user openshift-acme --role-namespace="$(oc project --short)" -z openshift-acme
$ oc new-app deployment-template.yml \
-p NAME=projectquay-docs-preview \
-p SOURCE_REPOSITORY_URL=https://github.com/<your-username>/quay-docs.git \
-p SOURCE_REPOSITORY_REF=<your-current-branch>
$ oc new-app deployment-template.yml \
-p NAME=projectquay-docs-production \
-p APPLICATION_DOMAIN=docs.projectquay.io