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

Use render-link hook to resolve references in specs #6032

Merged
merged 1 commit into from
Jan 22, 2025

Conversation

chalin
Copy link
Contributor

@chalin chalin commented Jan 22, 2025

  • Fixes [infra] Eliminate use of relref in spec and other pages #6025
  • Adds code to the render-link hook to resolve intra-spec references in a manner that was previously done using relref. The relref function is no longer used / emitted.
  • Greatly simplifies scripts/content-modules/adjust-pages.pl by removing link-transformation code that was previously used to insert relref function calls, and rename README.md. We might eventually be able to move more of the adjust-pages.pl functionality into the render-link hook.

The only change to the generated site files is the addition of trailing / at the end of /docs/specs/otel/document-status links in semconv pages:

$ (cd public && git diff -bw --ignore-blank-lines -I '/docs/specs/otel/document-status' -I 'modified_time|Last modified|dateModified' -- . ':(exclude)*.xml') | grep ^diff
diff --git a/site/index.html b/site/index.html

Preview: https://deploy-preview-6032--opentelemetry.netlify.app/docs/specs/

@chalin chalin added the CI/infra CI & infrastructure label Jan 22, 2025
@chalin chalin requested a review from a team as a code owner January 22, 2025 17:33
Copy link
Contributor

@tiffany76 tiffany76 left a comment

Choose a reason for hiding this comment

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

RSLGTM.

@chalin chalin added this pull request to the merge queue Jan 22, 2025
Merged via the queue into open-telemetry:main with commit c81613f Jan 22, 2025
17 checks passed
@chalin chalin deleted the chalin-im-relref-2025-01-22 branch January 22, 2025 18:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/infra CI & infrastructure sig:spec
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

[infra] Eliminate use of relref in spec and other pages
2 participants