Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RHDEVDOCS 5933 fix spec in configuring PAC #74504

Merged

Conversation

mramendi
Copy link
Contributor

@mramendi mramendi commented Apr 10, 2024

Version(s):

please cp to pipelines-docs-1.11, pipelines-docs-1.12, pipelines-docs-1.13, pipelines-docs-1.14

Issue:

RHDEVDOCS 5933

Link to docs preview:

https://74504--ocpdocs-pr.netlify.app/openshift-pipelines/latest/pac/install-config-pipelines-as-code.html#customizing-pipelines-as-code-configuration_install-config-pipelines-as-code

QE review:

  • QE has approved this change.

Additional information:

@openshift-ci openshift-ci bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Apr 10, 2024
@ocpdocs-previewbot
Copy link

🤖 Wed Apr 10 21:23:05 - Prow CI generated the docs preview:

https://74504--ocpdocs-pr.netlify.app/openshift-pipelines/latest/pac/install-config-pipelines-as-code.html

@mramendi
Copy link
Contributor Author

@@ -6,7 +6,7 @@
= Customizing {pac} configuration

[role="_abstract"]
To customize {pac}, cluster administrators can configure the following parameters in the `TektonConfig` custom resource, in the `pipelinesAsCode.settings` spec:
To customize {pac}, cluster administrators can configure the following parameters in the `TektonConfig` custom resource, in the `platforms.openshift.pipelinesAsCode.settings` spec:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we mention spec. also in start?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not really as the word "spec" implies it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Example of such use: https://docs.openshift.com/pipelines/1.14/create/remote-pipelines-tasks-resolvers.html#resolver-hub-config_remote-pipelines-tasks-resolvers

Other places do have "spec." but they call it "parameter".

It's a good question of consistency to raise on a higher level, I guess. I'll try to raise it. Meanwhile can we go on with this merge?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have raised it with other writers and the answers I got were generally in support of the way I did it

Copy link

openshift-ci bot commented Apr 12, 2024

@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/test-infra repository. I understand the commands that are listed here.

@savitaashture
Copy link

LGTM

@mramendi
Copy link
Contributor Author

/label peer-review-needed

@openshift-ci openshift-ci bot added the peer-review-needed Signifies that the peer review team needs to review this PR label Apr 16, 2024
@xenolinux
Copy link
Contributor

/label peer-review-in-progress

@openshift-ci openshift-ci bot added the peer-review-in-progress Signifies that the peer review team is reviewing this PR label Apr 16, 2024
Copy link
Contributor

@xenolinux xenolinux left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

/remove-label peer-review-needed
/remove-label peer-review-in-progress
/label peer-review-done

@openshift-ci openshift-ci bot added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR peer-review-in-progress Signifies that the peer review team is reviewing this PR labels Apr 16, 2024
@mramendi
Copy link
Contributor Author

/label merge-review-needed

@openshift-ci openshift-ci bot added the merge-review-needed Signifies that the merge review team needs to review this PR label Apr 16, 2024
@piyush-garg
Copy link

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Apr 17, 2024
@kcarmichael08 kcarmichael08 added peer-review-in-progress Signifies that the peer review team is reviewing this PR pipelines and removed merge-review-needed Signifies that the merge review team needs to review this PR labels Apr 17, 2024
@kcarmichael08 kcarmichael08 merged commit c495aa3 into openshift:pipelines-docs-main Apr 17, 2024
3 checks passed
@kcarmichael08
Copy link
Contributor

/cherrypick pipelines-docs-1.11

@kcarmichael08
Copy link
Contributor

/cherrypick pipelines-docs-1.12

@kcarmichael08
Copy link
Contributor

/cherrypick pipelines-docs-1.13

@kcarmichael08
Copy link
Contributor

kcarmichael08 commented Apr 17, 2024

/cherrypick pipelines-docs-1.14

@openshift-cherrypick-robot

@kcarmichael08: new pull request created: #74768

In response to this:

/cherrypick pipelines-docs-1.11

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/test-infra repository.

@openshift-cherrypick-robot

@kcarmichael08: new pull request created: #74769

In response to this:

/cherrypick pipelines-docs-1.12

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/test-infra repository.

@openshift-cherrypick-robot

@kcarmichael08: new pull request created: #74770

In response to this:

/cherrypick pipelines-docs-1.13

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/test-infra repository.

@kcarmichael08
Copy link
Contributor

/cherrypick pipelines-docs-1.14

@openshift-cherrypick-robot

@kcarmichael08: new pull request created: #74771

In response to this:

/cherrypick pipelines-docs-1.14

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/test-infra repository.

@kcarmichael08 kcarmichael08 removed the peer-review-in-progress Signifies that the peer review team is reviewing this PR label Apr 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lgtm Indicates that a PR is ready to be merged. peer-review-done Signifies that the peer review team has reviewed this PR pipelines size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

8 participants