OCPBUGS-36797: Revisit links to upstream docs in API #226
Conversation
alebedev87
commented
Aug 28, 2024
•
alebedev87
commented
- Removed links that don't add value and may mislead users (AWS, Infoblox: secret format).
- Pinned remaining links to specific commits and anchored them to relevant chapters.
openshift-ci-robot
added
jira/severity-low
|
@alebedev87: This pull request references Jira Issue OCPBUGS-36797, which is invalid:
Comment The bug has been updated to refer to the pull request using the external bug tracker. In response to this:
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 openshift-eng/jira-lifecycle-plugin repository. |
|
/jira refresh |
openshift-ci-robot
added
jira/valid-bug
|
@alebedev87: This pull request references Jira Issue OCPBUGS-36797, which is valid. The bug has been moved to the POST state. 3 validation(s) were run on this bug
Requesting review from QA contact: In response to this:
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 openshift-eng/jira-lifecycle-plugin repository. |
|
As this is doc link removal, QE will verify this after the merger.... |
|
/assign @Miciah |
|
@alebedev87: This pull request references Jira Issue OCPBUGS-36797, which is valid. 3 validation(s) were run on this bug
Requesting review from QA contact: In response to this:
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 openshift-eng/jira-lifecycle-plugin repository. |
| @@ -304,7 +300,7 @@ type ExternalDNSAzureProviderOptions struct { | |||
| // } | |||
| // | |||
| // See | |||
| // https://github.com/kubernetes-sigs/external-dns/blob/master/docs/tutorials/azure.md | |||
| // https://github.com/kubernetes-sigs/external-dns/blob/226dbb931f7a2019810b3703aec096c4ea4f40ea/docs/tutorials/azure.md#configuration-file | |||
There was a problem hiding this comment.
This is fine for now, but I hope in the future we will have some product documentation that we can reference instead.
There was a problem hiding this comment.
My goal was to show which fields can be put into the config. The previous link was a shot in the dark, this change makes the link at least useful. Btw, the config content is kinda opaque for the operator as we don't validate or enforce anything for the moment. But I agree the ultimate goal is to have this in the OCP docs.
There was a problem hiding this comment.
@jmanthei : Can you help us with adding of the Azure config file for EzternalDNS' Azure provider to the docs?
UPD: AWS, GCP and Infoblox would need to be there too.
There was a problem hiding this comment.
@alebedev87 I'm happy to help- do you have links to existing config files for these that I can glean information from? How soon does this need to be done?
There was a problem hiding this comment.
@jmanthei: We can take the upstream links as example. For instance this one from the PR for Azure.
There was a problem hiding this comment.
How soon does this need to be done?
It's not urgent.
| // See | ||
| // https://github.com/kubernetes-sigs/external-dns/blob/master/docs/tutorials/bluecat.md | ||
| // https://github.com/kubernetes-sigs/external-dns/blob/226dbb931f7a2019810b3703aec096c4ea4f40ea/docs/tutorials/bluecat.md#using-json-configuration-file | ||
| // for more information on the necessary configuration values and how to obtain them. |
There was a problem hiding this comment.
The linked documentation just seems to say which fields are required and which are not, but not how to obtain them. I think this change is fine since the goal is just to fix the link, but as I mentioned in my other comment, it would be good in the future to link to product documentation instead.
There was a problem hiding this comment.
Right, this one was really for consistency (with Azure). Btw BlueCat is going away so we don't need to bother about it.
|
Thanks! |
|
/approve Wake up, Neo ... |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: alebedev87, Miciah The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-ci
bot
added
the
approved
- Removed links that don't add value and may mislead users. - Pinned remaining links to specific commits and anchored them to relevant chapters.
|
/retest-required |
alebedev87
force-pushed
the
infoblox-remove-upstream-doc
branch
from
dafa06e to
dd227ae
Compare
|
/test e2e-gcp-operator |
Synchronizes the File-Based Catalog (FBC) with infrastructure annotations from the latest bundle. This update resolves `make verify` target failures by regenerating the catalog via `make catalog`.
alebedev87
force-pushed
the
infoblox-remove-upstream-doc
branch
from
dd227ae to
af77cf2
Compare
|
/test e2e-aws-shared-vpc-phz-operator |
|
@alebedev87: 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. |
|
Thanks! |
|
@alebedev87: Jira Issue OCPBUGS-36797: All pull requests linked via external trackers have merged: Jira Issue OCPBUGS-36797 has been moved to the MODIFIED state. In response to this:
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 openshift-eng/jira-lifecycle-plugin repository. |
