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

Fixes #2907 - Schema files are served from semantic-conventions. #2908

Closed
wants to merge 3 commits into from

Conversation

jsuereth
Copy link

@jsuereth jsuereth commented Jun 26, 2023

We'd like to move schema files to be served from the semantic-conventions repository. This is the first step, next we'd like to add an OpenTelemetry-Bot action that will bump the content module every time semantic conventions cuts a release.

DO NOT MERGE: This would make the 1.21.0 schema available immediately.

This PR is for review, to make sure this is the right approach for publishing schema files into the website going forward.

TODOS

  • Add semantic-conventions as subcontent module
  • Update auto-upgrade script to apply to semantic-conventions subcontent module
  • Add semantic conventions to ToC / index
  • Ensure semantic-conventions -> specification links are accurately internalized to the website
  • Ensure specification -> semantic-conventions links are accurately internalized to the website.
  • Remove specification/semantic_conventions/*.md from being pulled in OpenTelemetry specification.
  • Figure out if supplementary guidelines belong on the website

@chalin chalin force-pushed the wip-semconv-migration branch from 24480a8 to a65bb57 Compare June 27, 2023 20:46
@@ -15,7 +15,7 @@ cp -R $SRC/* $DEST/
find $DEST/ -name "README.md" -exec sh -c 'f="{}"; mv -- "$f" "${f%README.md}_index.md"' \;

# To exclude a file use, e.g.: -not -path '*/specification/_index.md'
FILES=$(find $DEST -name "*.md")
FILES=$(find $DEST -name "*.md" -not -path '*/specification/*/semantic_conventions/*')
Copy link
Contributor

Choose a reason for hiding this comment

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

We won't want to exclude anything from the OTel spec because that is likely to break things. Whatever the OTel spec repo decides to do with the semconv pages, we'll publish as is on the repo. For example, OTLP placeholder pages were left in the OTel spec after the move to the OTLP repo.

@chalin
Copy link
Contributor

chalin commented Jun 27, 2023

FYI, I rebased after the merge of #2918.

@chalin chalin marked this pull request as draft June 27, 2023 21:09
@jsuereth
Copy link
Author

Closing in favor of @chalin's PRs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants