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.

Sign up for GitHub

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

Jump to bottom

Coordinate ecosystem docsites to include link back to docs.ansible.com #877

Open
samccann opened this issue Nov 28, 2023 · 5 comments
Open

Coordinate ecosystem docsites to include link back to docs.ansible.com #877

samccann opened this issue Nov 28, 2023 · 5 comments
Labels
tooling This PR affects tooling (CI, pr_labeler, noxfile, linters, etc.) but not the docs builds themselves.

Comments

@samccann
Copy link
Contributor

All projects on this page should include a link back to docs.ansible.com
@samccann samccann moved this from 🆕 Triage to 📋 Backlog in Ansible Documentation Nov 28, 2023
@ansible-documentation-bot ansible-documentation-bot bot added the needs_triage Needs a first human triage before being processed. label Nov 28, 2023
@webknjaz
Copy link
Member

All projects on this page should include a link back to docs.ansible.com

Oh, I noticed that the ansible-pylibssh project is spelled weirdly (with a whitespace and capitalization!). Haven't found where to fix that.

As for the backlinks, updating the base Sphinx theme footer could address this. Alternatively, said projects would probably have to inherit the upstream footer and make a small tweak.

@samccann
Copy link
Contributor Author

@webknjaz - @oraNod is in the middle of having that page redirected to https://ansible.readthedocs.io/en/latest/ecosystem.html so if you follow the github link, you can likely find the source.

So only 1/2 the projects use the sphinx theme, but that does sound like a promising approach. Though I'm unsure we want a link back in the footer vs the header.

@gotmax23 gotmax23 mentioned this issue Nov 30, 2023
Open
@gotmax23
Copy link
Collaborator

I opened ansible/mkdocs-ansible#74 for the mkdocs theme.

@oraNod
Copy link
Contributor

oraNod commented Dec 5, 2023

All projects on this page should include a link back to docs.ansible.com

Oh, I noticed that the ansible-pylibssh project is spelled weirdly (with a whitespace and capitalization!). Haven't found where to fix that.

@webknjaz https://github.com/ansible/docsite/blob/0fd7e268e947c0fab26f6df515c82e2f755f3ee1/data/ecosystem.yaml#L88

@samccann samccann moved this from 📋 Backlog to 🏗 In progress in Ansible Documentation Jan 4, 2024
@samccann samccann added tooling This PR affects tooling (CI, pr_labeler, noxfile, linters, etc.) but not the docs builds themselves. and removed needs_triage Needs a first human triage before being processed. labels Jan 4, 2024
@samccann
Copy link
Contributor Author

Looking at the latest ansible sphinx theme, it already includes a link to docs.ansible.com
image

So when projects upgrade, they'll get that fix.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
tooling This PR affects tooling (CI, pr_labeler, noxfile, linters, etc.) but not the docs builds themselves.
Projects
Ansible Documentation
Status: 🏗 In progress
Milestone
No milestone
Development

No branches or pull requests
4 participants
@webknjaz @gotmax23 @samccann @oraNod