-
Notifications
You must be signed in to change notification settings - Fork 182
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
[editorial] service.md: normalize link to process.md #883
Conversation
This PR normalizes the link to process.md, droping the hash to the page title, since that breaks link checking in the OTel website, see open-telemetry/opentelemetry.io#4253 (review).
@chalin thank you! |
@lmolkova it refers to But the |
thanks for the clarification @trisch-me. I believe this conversion to |
Because on the OTel.io website, page titles don't have anchors, and hence they can't be linked to. In this repo (and any other OTel spec repo), it is a bit moot to link to the title, since the title is the first thing displayed on the page. So the win-win strategy is to instead just link to the page. Do you agree? |
@chalin I do agree, the problem is that it's hard to catch inside semconv - process.md#process is a valid link within the repo and does not fail the CI. So we have to rely on the reviewers to catch it, i.e. can't guarantee that new versions of semconv will be compatible with website links. |
The link needs to be normalized (to refer to a page, not the page title), otherwise OTel.io link checking fails; for details, see open-telemetry/opentelemetry.io#4253 (review).
/cc @joaopgrassi