docs: update readme for top-level generators (PSKD-1380) #595
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
Generators documented for inclusion in the base kustomization.yaml need adjusted handling for this project. This commit updates the README.md with the necessary details. Signed-off-by: Ed Overton <[email protected]>
Signed-off-by: Ed Overton <[email protected]>
dhoucgitter
reviewed
Feb 20, 2025
| @@ -184,6 +184,44 @@ For example: | |||
|
|
|||
| The SAS Viya platform customizations that are managed by viya4-deployment are located under the [templates](https://github.com/sassoftware/viya4-deployment/tree/main/roles/vdm/templates) directory. These are purposely templatized and included there since they contain a set of customizations that are common or required for a functioning SAS Viya platform deployment. These particular files are configured via exposed variables that are documented within [CONFIG-VARS.md](docs/CONFIG-VARS.md) and do not need to be manually placed under `/site-config`. | |||
|
|
|||
| #### Base kustomization.yaml ConfigMap and Secret Generators | |||
|
|
|||
| In some scenarios, documentation instructs you to add a `configMapGenerator` or `secretGenerator` entry to the base `kustomization.yaml` (also known as `$deploy/kustomization.yaml`). For example: | |||
There was a problem hiding this comment.
Could adding "In some scenarios, SAS Viya feature documentation instructs you to"
help clarify where you might get such an instruction?
It could also help tie the "with the documented" on line 213 back to an origin.
There was a problem hiding this comment.
After discussion on the phrasing with doc, I'll adjust this to:
In some scenarios, a README or the deployment documentation instructs you...
dhoucgitter
approved these changes
Feb 20, 2025
|
After discussion, I'm going to close this PR and open the change against main. This approach will allow a quicker and easier documentation-only update. Edited to add: #596 |
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.
Generators documented for inclusion in the base kustomization.yaml need adjusted handling for this project. This commit updates the README.md with the necessary details.