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

Support GH links to canonical src in lang repo #687

Merged

Conversation

chalin
Copy link
Contributor

@chalin chalin commented Aug 17, 2021

Contributes to #542

/cc @carlosalberto @mtwo @shelbyspees

As mentioned in the file, this is a Docsy file override. Here is the diff:

$ diff {themes/docsy/,}layouts/partials/page-meta-links.html
0a1
> {{/* otel-docsy file override */ -}}
16a18
> {{ $gh_repo_path = replace $gh_repo_path ($.Param "path_base_for_github_subdir") "" -}}

@chalin chalin added the CI/infra CI & infrastructure label Aug 17, 2021
@chalin chalin requested a review from a team August 17, 2021 12:57
@chalin
Copy link
Contributor Author

chalin commented Aug 17, 2021

Exceptionally, I've also submitted a commit matching the changes in open-telemetry/opentelemetry-java#3501 so that you can validate the change. (I can either pull out that commit before merging, or leave it in -- I don't think that it should cause problems for the website_docs PR that will be eventually created from the OTel Java repo.)

Preview: https://deploy-preview-687--opentelemetry.netlify.app/docs/java/ -- from there you can also check the subpages.

Note that Edit this page, for example, now links to https://github.com/open-telemetry/opentelemetry-java/edit/main/website_docs/_index.md.

@chalin
Copy link
Contributor Author

chalin commented Aug 17, 2021

Note in passing how this split of the docs (as introduced by #472) makes it more challenging to preview changes. #661 will make it possible to preview changes without having to commit changes in two repos.

@chalin
Copy link
Contributor Author

chalin commented Aug 17, 2021

When creating an issue using the Create documentation issue link, the issue title is set to the page title by default. We'll likely want to tweak that (by, say, adding a prefix like Website:), but I suggest that we address this in a followup issue & PR.

@chalin chalin force-pushed the chalin-gh-repo-link-fix-2021-08-16 branch from 6664020 to f4a440f Compare August 17, 2021 18:32
@chalin
Copy link
Contributor Author

chalin commented Aug 17, 2021

Rebased after merging OTel Java change.

@chalin chalin merged commit d3e6fb7 into open-telemetry:main Aug 17, 2021
@chalin chalin deleted the chalin-gh-repo-link-fix-2021-08-16 branch August 17, 2021 18:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/infra CI & infrastructure
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants