Documentation landing page links in the section headers are hard to find
See original GitHub issueApache Airflow version: N/A - current documentation
Kubernetes version (if you are using kubernetes) (use kubectl version
): N/A
Environment: N/A
- Cloud provider or hardware configuration: N/A
- OS (e.g. from /etc/os-release): N/A
- Kernel (e.g.
uname -a
): N/A - Install tools: N/A
- Others: N/A
What happened: I had spent quite some time looking for the documentation pages on https://airflow.apache.org/docs/ till I realized that actually the section headers are the links to the documentation pages. This is highly counter-intuitive (a link on a section header is normally a permalink to the section header and not another page.) and is generally a terribly bad UI user experience. For the first glance it seems Airflow does not have any documentation apart from the landing page!
What you expected to happen: Documentation pages should be intuitive to navigate. One would normally expect proper links to other sections of documentation. For example: “Read the Documentation >>” as link text at the end of each section or something similar.
How to reproduce it: Get someone new to the project look at the documentation landing page with a fresh pair of eyes and ask them to locate the links to the main documentation.
Anything else we need to know:
Issue Analytics
- State:
- Created 2 years ago
- Comments:7 (4 by maintainers)
Top GitHub Comments
I could imagine something like this, with “Read the documentation” being a link to the corresponding sub-page:
OK, I’ve created my first AirFlow pull request 😃
https://github.com/apache/airflow-site/pull/434