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

Navigation between multiple documentation packages #14764

Open
mik-laj opened this issue Mar 13, 2021 · 1 comment
Open

Navigation between multiple documentation packages #14764

mik-laj opened this issue Mar 13, 2021 · 1 comment
Labels

Comments

@mik-laj
Copy link
Member

mik-laj commented Mar 13, 2021

Hello,

We have many packages with documentation, but the navigation between these packages is not very intuitive. Some people find documentation on Google and they don't know that they should try to check the documentation for a different package as it may contain related information. I think you have to think about what we can do to make users more aware and easier to find the documentation.

I think we can be inspired by the documentation for Terraform. It has a drop-down menu with links to all documentation in the top bar.
Screenshot 2021-03-10 at 00 38 29
They also have links to other documentation packages in the side menu.
Screenshot 2021-03-10 at 00 38 43
It is worth checking if we have references to other documentation packages in the content itself. For example: documentation on PIP installation has a link to provider packages documentation.
Screenshot 2021-03-14 at 00 12 32
We do not have any reference to helm-chart package from the apache-airflow package, although it would be helpful on the Kubernetes page.

Originally posted by @mik-laj in #14644 (comment)

@mik-laj mik-laj added the kind:feature Feature Requests label Mar 13, 2021
@potiuk
Copy link
Member

potiuk commented Mar 13, 2021

+1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants