CLOUD-2459 - correct documentation links and provide README information #80
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bstansberry
approved these changes
Apr 10, 2018
|
@bstansberry sorry for the second push. While looking at https://github.com/openshift/library/blob/master/official.yaml I noticed their use of the autogenerated template docs, so this adds those as well. (the py script generates these, its a modified version taken from application_templates). |
bstansberry
approved these changes
Apr 11, 2018
maschmid
reviewed
Apr 11, 2018
template.adoc.in
Outdated
| ===== Service Accounts | ||
|
|
||
| Service accounts are API objects that exist within each project. They can be created or deleted like any other API object. Refer to the | ||
| https://docs.openshift.com/enterprise/3.0/dev_guide/service_accounts.html#managing-service-accounts[Openshift documentation] for more |
There was a problem hiding this comment.
we should link to a more recent version of the openshift docs
maschmid
reviewed
Apr 11, 2018
template.adoc.in
Outdated
|
|
||
| A `PersistentVolume` object is a storage resource in an OpenShift cluster. Storage is provisioned by an administrator | ||
| by creating `PersistentVolume` objects from sources such as GCE Persistent Disks, AWS Elastic Block Stores (EBS), and NFS mounts. | ||
| Refer to the https://docs.openshift.com/enterprise/3.0/dev_guide/persistent_volumes.html#overview[Openshift documentation] for |
There was a problem hiding this comment.
also here, lets use the current OCP version link instead
maschmid
reviewed
Apr 11, 2018
README.adoc
Outdated
| ---- | ||
| $ keytool -genkey -keyalg RSA -alias eapdemo-selfsigned -keystore keystore.jks -validity 360 -keysize 2048 | ||
| $ oc secrets new eap7-app-secret keystore.jks | ||
| $ oc secrets link eap-service-account eap7-app-secret |
There was a problem hiding this comment.
we use the default service account now in the templates.
also the linking isn't required AFAIK
maschmid
reviewed
Apr 11, 2018
template.adoc.in
Outdated
| {#secrets} | ||
| ==== Secrets | ||
|
|
||
| This template requires link:../secrets/{secretName}.adoc[{secretFile}] |
|
@maschmid corrected and regenerated docs, thanks |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Ken Wills kwills@redhat.com
https://issues.jboss.org/browse/CLOUD-2459