[GitHub] [airflow] mik-laj opened a new issue #14764: Navigation between multiple documentation packages

[GitBox]

mik-laj opened a new issue #14764:
URL: https://github.com/apache/airflow/issues/14764


   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.
   <img width="390" alt="Screenshot 2021-03-10 at 00 38 29" 
src="https://user-images.githubusercontent.com/12058428/110553395-322f1f00-8139-11eb-976b-c88b84f85b6d.png";>
   They also have links to other documentation packages in the side menu.
   <img width="513" alt="Screenshot 2021-03-10 at 00 38 43" 
src="https://user-images.githubusercontent.com/12058428/110553284-13c92380-8139-11eb-83b2-23711e5cb4b9.png";>
   It is worth checking if we have references to other documentation packages 
in the content itself. For example: documentation on [PIP 
installation](http://airflow.apache.org/docs/apache-airflow/stable/installation.html)
 has a link to provider packages documentation.
   <img width="906" alt="Screenshot 2021-03-14 at 00 12 32" 
src="https://user-images.githubusercontent.com/12058428/111052374-77659080-845a-11eb-92e2-f783bd99b9e3.png";>
   We do not have any reference to `helm-chart` package from the 
`apache-airflow` package, although it would be helpful on [the Kubernetes 
page](http://airflow.apache.org/docs/apache-airflow/stable/kubernetes.html).
   
   _Originally posted by @mik-laj in 
https://github.com/apache/airflow/issues/14644#issuecomment-794613029_


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org