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

docs(website): support GH page links to canonical src #2421

Merged

Conversation

chalin
Copy link
Contributor

@chalin chalin commented Aug 18, 2021

Contributes to open-telemetry/opentelemetry.io#542

/cc @carlosalberto @mtwo @shelbyspees @austinlparker

While I can't (currently) show you a preview of this PR, you can see the corresponding change for OTel Java in action by clicking on the Edit this page and related links, from https://opentelemetry.io/docs/java/ and it's subpages.

@dyladan @obecny @vmarchaud: I see that this repo doesn't yet have a docs-update GitHub action. If you prefer, I can link OTel JS website_docs to the OTel website via a git submodule -- similar to what I did for Go in Link to OTel Go website_docs via submodule - open-telemetry/opentelemetry.io#690. That way you won't need to submit website_docs PRs.

Context: #2051

@codecov
Copy link

codecov bot commented Aug 18, 2021

Codecov Report

Merging #2421 (dcf5621) into main (dfb597d) will decrease coverage by 0.36%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #2421      +/-   ##
==========================================
- Coverage   92.72%   92.36%   -0.37%     
==========================================
  Files         137      114      -23     
  Lines        4990     3901    -1089     
  Branches     1054      842     -212     
==========================================
- Hits         4627     3603    -1024     
+ Misses        363      298      -65     
Impacted Files Coverage Δ
...emetry-core/src/platform/node/RandomIdGenerator.ts 87.50% <0.00%> (-6.25%) ⬇️
...opentelemetry-api-metrics/src/NoopMeterProvider.ts
...emetry-instrumentation-xml-http-request/src/xhr.ts
packages/opentelemetry-sdk-trace-web/src/types.ts
packages/opentelemetry-sdk-trace-web/src/utils.ts
...kages/opentelemetry-api-metrics/src/api/metrics.ts
...ation-xml-http-request/src/enums/AttributeNames.ts
...ry-exporter-collector/src/CollectorExporterBase.ts
...emetry-api-metrics/src/platform/node/globalThis.ts
...s/opentelemetry-instrumentation-fetch/src/fetch.ts
... and 14 more

@dyladan
Copy link
Member

dyladan commented Aug 24, 2021

@dyladan @obecny @vmarchaud: I see that this repo doesn't yet have a docs-update GitHub action. If you prefer, I can link OTel JS website_docs to the OTel website via a git submodule -- similar to what I did for Go in Link to OTel Go website_docs via submodule - open-telemetry/opentelemetry.io#690. That way you won't need to submit website_docs PRs.

That sounds great! Keeping the website docs up to date isn't a hard task, but it is one more thing that needs to be remembered and can be forgotten each time we update the docs.

@chalin
Copy link
Contributor Author

chalin commented Aug 24, 2021

Hi all. Anything to be done before this can be approved and merged?

@dyladan dyladan changed the title Website: support GH page links to canonical src docs(website): support GH page links to canonical src Aug 27, 2021
@dyladan
Copy link
Member

dyladan commented Aug 27, 2021

We need another approver before we can merge

Copy link
Member

@obecny obecny left a comment

Choose a reason for hiding this comment

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

lgtm

@dyladan
Copy link
Member

dyladan commented Aug 27, 2021

The browser test failure is completely unrelated. I'm going to merge.

@dyladan dyladan merged commit c69251e into open-telemetry:main Aug 27, 2021
@chalin chalin deleted the chalin-website-gh-link-fix-2021-08-18 branch September 7, 2021 14:42
@dyladan dyladan added the document Documentation-related label Sep 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
document Documentation-related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants