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

Add the specification to the docs #866

Merged
merged 9 commits into from
Nov 9, 2021

Conversation

chalin
Copy link
Contributor

@chalin chalin commented Oct 27, 2021

Here's a preview of the spec published via the website:

This requires no extra effort on the part of the spec maintainers other than to let us know when the spec is updated so that we can update it here too.

Contributes to #852. (There will be some followup & cleanup items, but they can be addressed in a separate PR.)

@bhs @tedsuo @open-telemetry/specs-approvers WDYT?

/cc @celestehorgan @nate-double-u

@chalin chalin requested a review from a team October 27, 2021 19:55
@chalin chalin marked this pull request as draft October 27, 2021 19:56
@reyang
Copy link
Member

reyang commented Oct 27, 2021

Here's a preview of the spec published via the website:

How do I access the link? It shows HTTP 404.

@chalin
Copy link
Contributor Author

chalin commented Oct 27, 2021

There's a build issue on Netlify that doesn't occur locally. I'm still investigating. I'll comment here once the issue is resolved.

@chalin chalin marked this pull request as ready for review October 27, 2021 20:04
@chalin
Copy link
Contributor Author

chalin commented Oct 27, 2021

The preview is now live! ✨

@chalin chalin added docs enhancement New feature or request CI/infra CI & infrastructure labels Oct 27, 2021
@chalin
Copy link
Contributor Author

chalin commented Oct 29, 2021

Repo links (like Edit page), now refer to the https://github.com/open-telemetry/opentelemetry-specification repo.

(All such links work, except for the top-level Specification index page, since that page isn't in the website repo yet -- the page is being added by this PR.)

@chalin chalin force-pushed the chalin-spec-2021-10-27 branch 3 times, most recently from b631491 to 406f5da Compare November 2, 2021 18:09
@chalin chalin force-pushed the chalin-spec-2021-10-27 branch from 406f5da to 5895db8 Compare November 4, 2021 15:12
@chalin chalin force-pushed the chalin-spec-2021-10-27 branch from 5895db8 to 1c388eb Compare November 4, 2021 15:16
@chalin
Copy link
Contributor Author

chalin commented Nov 4, 2021

As mentioned in #852 (comment):

  • I've implemented option 3 [put the spec under /docs/reference] , and
  • Replaced the "Edit page" button by a "View page source"

PTAL

@austinlparker
Copy link
Member

Hold merge until after 11/9/21

@chalin
Copy link
Contributor Author

chalin commented Nov 9, 2021

With that in mind, unless there are other blockers we'll be merging #866 next Tuesday.

No objections raised. Merging.

@chalin chalin merged commit c39f529 into open-telemetry:main Nov 9, 2021
@chalin chalin deleted the chalin-spec-2021-10-27 branch November 9, 2021 15:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/infra CI & infrastructure docs enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants