Then contributing to this repository, please follow the below style guide.
Since people have started using this repository, no un-reviewed code will be allowed in the master branch.
Follow the Adding Content procedure to add your content. This applies to new documents as well as additions to already existing documents.
Once you are satisfied with your content and it has been verified by you, open a pull request to merge your branch into master.
To open a PR you can follow these steps:
-
Create a new branch in which you work. The branch name should include your name.
-
Including your name helps us in finding out if the branch can be recycled
-
-
Only work inside of your branch
-
For Workloads create a new folder in the scheme
ocs4<workload>where workload should explain what your workload is about. Example:ocs4metrics -
Write your content in ASCIIdoc format - respect the ASCIIdoc styling information below
It is best practice to copy this to the beginning of your workshop:
= YOUR TITLE :toc: right :toclevels: 2 :icons: font :source-language: bash :numbered: // Activate experimental attribute for Keyboard Shortcut keys :experimental:
This produces good defaults for your document.
To make our lifes easier once we move over to Homeroom, please tag each executable command and follow this styling:
[source,role="execute"] ---- oc get replicaset -n openshift-monitoring ---- .Example output: ---- NAME DESIRED CURRENT READY AGE cluster-monitoring-operator-84cd9df668 1 1 1 6d23h grafana-5db6fd97f8 1 1 1 6d23h kube-state-metrics-895899678 1 1 1 6d23h openshift-state-metrics-77d5f699d8 1 1 1 6d23h prometheus-adapter-57db7c5495 0 0 0 6d4h prometheus-adapter-67469c5b8b 0 0 0 6d23h prometheus-adapter-74f79b678f 0 0 0 6d4h prometheus-adapter-7cd7578f49 2 2 2 6d prometheus-operator-5df7bc8b4f 0 0 0 6d23h prometheus-operator-6584955c55 0 0 0 6d23h prometheus-operator-cbfd89f9 1 1 1 6d23h telemeter-client-66db9b8bb5 0 0 0 6d23h telemeter-client-7c65855db4 1 1 1 6d23h ----
Expect people to not pull the ocs-training repository.
If you want to apply a specific file, use the raw link from within Github
Do NOT do this:
Create kafka topic
oc apply -f 02-kafka-topic.yamlInstead DO this:
Create kafka topic
oc apply -f https://github.com/red-hat-storage/ocs-training/raw/master/ocs4kafka/02-kafka-topic.yaml
Keyboard shortcuts should leverage the built-in ASCIIdoc format
Do NOT do this:
press ``ctrl+c`` to cancel
Instead DO this:
press kbd:[Ctrl+C] to cancel
For this to work, you need to first activate the experimental features in your document by adding this to the top:
// Activate experimental attribute for Keyboard Shortcut keys :experimental:
Do NOT do this:
Once you finished these steps, you can see that we successfully mounted the rwx pvc inside of our toolbox pod, while it is also still mounted on the registry pods.
Instead DO this:
Once you finished these steps, you can see that we successfully mounted the RWX PVC inside of our toolbox Pod, while it is also still mounted on the registry Pods.
Github unfortunately does not support many ASCIIdoc features. Until we are deploying inside of Homeroom, your lab needs to look decent inside of Github!
One of the features that Github lacks is import: to include another document inside of another document. It is up to you to verify that the ASCIIdoc you produce works on Github.