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

Edit/Create links for docs pages should point to authoritative sources #542

Closed
6 tasks done
Tracked by #769
austinlparker opened this issue Apr 14, 2021 · 9 comments · Fixed by open-telemetry/opentelemetry-php#454 or #857
Closed
6 tasks done
Tracked by #769
Assignees
Labels
e2-days Effort: < 5 days

Comments

@austinlparker
Copy link
Member

austinlparker commented Apr 14, 2021

Currently, on each doc page there's a set of links in the upper-right above the doc ToC for opening issues/creating child pages for a docs page.
image

It would be nice if these could point to the upstream source (i.e., open-telemetry/opentelemetry-java/website_docs) rather than the website repo itself.

This would require some Docsy hacking, as these are set in themes/docsy/layouts/partials/page-meta-links.html.


Edit(@chalin): tracking changes (as of 2021/08/18)

@harshita19244
Copy link
Contributor

@austinlparker I would like to work on it, could you assign it to me?

@harshita19244
Copy link
Contributor

I had a question, to make these changes, do I need to directly modify the code in the Docsy repo? Since the themes/docsy points to the actual Docsy repo itself. Do I send a pr there? @austinlparker

@austinlparker
Copy link
Member Author

I don't think we should change the underlying theme (as that means we wouldn't be able to update it easily) - Hugo has a lookup order for partials, so we could customize it by creating a copy of it then tweaking it. See https://gohugo.io/templates/partials/ for more information on how the template lookups work.

@chalin
Copy link
Contributor

chalin commented Aug 12, 2021

Hi all. Need a hand with this? I've implemented this in other website repos, and would be glad to set this up here too (once I'm done with basic infrastructure cleanup).

@chalin chalin added e2-days Effort: < 5 days p1-high labels Aug 12, 2021
@chalin
Copy link
Contributor

chalin commented Aug 16, 2021

Mind if I pickup work on this issue @harshita19244?

@chalin
Copy link
Contributor

chalin commented Aug 16, 2021

@austinlparker - By the way, there's a "feature interaction" with multi-language support -- which the website is currently ready for, though currently on en is supported. That is, language repos should probably be setup for multi-language support as well. Thoughts?

@chalin chalin self-assigned this Aug 17, 2021
@chalin
Copy link
Contributor

chalin commented Aug 17, 2021

Self-assigning. The first couple of PRs are landing soon.

@chalin
Copy link
Contributor

chalin commented Aug 17, 2021

Mind if I pickup work on this issue @harshita19244?

@harshita19244 - FYI, I'll be completing the resolution of this issue. Thanks for your original interest!

@chalin
Copy link
Contributor

chalin commented Sep 24, 2021

See #730

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
e2-days Effort: < 5 days
Projects
None yet
3 participants