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

Link check workflow might be broken or bugged #65

Open
asimpleidea opened this issue Oct 27, 2021 · 5 comments
Open

Link check workflow might be broken or bugged #65

asimpleidea opened this issue Oct 27, 2021 · 5 comments
Labels
bug Something isn't working documentation Improvements or additions to documentation wontfix This will not be worked on

Comments

@asimpleidea
Copy link
Member

Go here: https://github.com/CloudNativeSDWAN/cnwan-operator/blob/master/docs/etcd/quickstart.md#2---deploy-a-test-service and search for this line

Please notice that the namespace has this label: operator.cnwan.io/watch: enabled which inserts the namespace in the opeartor's allowlist. Also notice that the service has annotations that will be registered as metadata:

This link: ./concepts.md#namespace-lists does not really exist but the link check workflow is not catching this, probably because it doesn't work well with anchors :(

@asimpleidea asimpleidea added bug Something isn't working documentation Improvements or additions to documentation wontfix This will not be worked on labels Oct 27, 2021
@asimpleidea
Copy link
Member Author

asimpleidea commented Oct 27, 2021

I am labelling this as wontfix as this is an external workflow over which we have very little control. I am going to try and see if an update is available that hopefully fixes this.

@arnatal
Copy link
Member

arnatal commented Oct 27, 2021

If it doesn't exist, shouldn't we just remove the link to ./concepts.md#namespace-lists then?

@asimpleidea
Copy link
Member Author

asimpleidea commented Oct 27, 2021

Yes I am taking care of this and the others in the other QuickStarts, but it means that there may be other broken anchors that we are not aware of somewhere in the docs and this also means that the workflow will not be able to catch other potential ones in future PRs

@arnatal
Copy link
Member

arnatal commented Oct 27, 2021

Ah I see, in that case, I agree it's not worth our time to try to find all broken anchors. We can just remove the ones we find as we work on other commits and hope an update in the workflow fixes this eventually.

@ljakab
Copy link
Member

ljakab commented Nov 9, 2021

Since you added wontfix, I think we can close this, right?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation wontfix This will not be worked on
Projects
None yet
Development

No branches or pull requests

3 participants