RHDEVDOC 5980 set medatata on target namespace #75535
Conversation
openshift-ci
bot
added
the
size/M
|
🤖 Mon May 13 16:50:14 - Prow CI generated the docs preview: |
| name: config | ||
| spec: | ||
| targetNamespaceMetadata: | ||
| labels: {"example-label"} |
There was a problem hiding this comment.
label should be key value pair
labels: {"example-label":"example-value"}
There was a problem hiding this comment.
LGTM
We have to wait till the feature PR gets merged: tektoncd/operator#2132
|
/label peer-review-needed |
openshift-ci
bot
added
the
peer-review-needed
|
/label peer-review-in-progress |
openshift-ci
bot
added
the
peer-review-in-progress
| targetNamespaceMetadata: | ||
| labels: {"example-label":"example-value"} | ||
| annotations: {"example-annotation":"example-value"} |
There was a problem hiding this comment.
| targetNamespaceMetadata: | |
| labels: {"example-label":"example-value"} | |
| annotations: {"example-annotation":"example-value"} | |
| targetNamespaceMetadata: | |
| labels: {"<label_name>":"<label_value>"} | |
| annotations: {"<anotation_name>":"<anotation_value>"} |
There was a problem hiding this comment.
https://redhat-documentation.github.io/supplementary-style-guide/#user-replaced-values
Surrounded by angle brackets (< >)
Separated by underscores (_) for multi-word values
There was a problem hiding this comment.
@xenolinux this would be a syntax definition while what I have is an example. The reason I went for an example is because the surrounding similar modules are examples. For example (yeah), https://75535--ocpdocs-pr.netlify.app/openshift-pipelines/latest/install_config/customizing-configurations-in-the-tektonconfig-cr.html#op-changing-default-service-account_customizing-configurations-in-the-tektonconfig-cr has "stable", not "<api_fields_level>"
There was a problem hiding this comment.
After looking at other sections, I agree with you. +1 to keep consistency with other sections.
|
|
||
| To set the labels and annotations, use the `spec.targetNamespaceMetadata` specification in the `TektonConfig` custom resource (CR). | ||
|
|
||
| .Example of setting labels and annotations for the `openshift-pipelines` namespace |
There was a problem hiding this comment.
| .Example of setting labels and annotations for the `openshift-pipelines` namespace | |
| .Example `TektonConfig` CR |
IMO, this can be kept short because heading and description already indicate users about setting labels and annotations.
Up to you though!
There was a problem hiding this comment.
There are many examples of this same CR in this module, so I do want to keep this more specific
openshift-ci
bot
added
peer-review-done
|
/label merge-review-needed |
openshift-ci
bot
added
the
merge-review-needed
|
@mramendi: all tests passed! Full PR test history. Your PR dashboard. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
|
/remove-label merge-review-needed |
openshift-ci
bot
removed
the
merge-review-needed
Version(s):
pipelines-docs-main
Issue:
RHDEVDOCS 5980
Link to docs preview:
https://75535--ocpdocs-pr.netlify.app/openshift-pipelines/latest/install_config/customizing-configurations-in-the-tektonconfig-cr.html#op-setting-annotations-labels-namespace_customizing-configurations-in-the-tektonconfig-cr
QE review:
Additional information:
NOTE TO PEER/MERGE REVIEWERS: the added module uses a concept format and not a procedure format in order to preserve uniformity with other modules in the assembly. Adding a full procedure to edit the TektonConfig CR to every module would be repetitive and would also make for a very large PR. See the preview. or else https://docs.openshift.com/pipelines/1.14/install_config/customizing-configurations-in-the-tektonconfig-cr.html#op-changing-default-service-account_customizing-configurations-in-the-tektonconfig-cr in the current documentation, for several modules that immediately precede this module