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

Documentation landing page links in the section headers are hard to find #16431

Closed
peter-gergely-horvath opened this issue Jun 14, 2021 · 7 comments · Fixed by apache/airflow-site#434
Labels
kind:bug This is a clearly a bug

Comments

@peter-gergely-horvath
Copy link

Apache 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.

airflow_documentation_page

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:

@peter-gergely-horvath peter-gergely-horvath added the kind:bug This is a clearly a bug label Jun 14, 2021
@boring-cyborg
Copy link

boring-cyborg bot commented Jun 14, 2021

Thanks for opening your first issue here! Be sure to follow the issue template!

@potiuk
Copy link
Member

potiuk commented Jun 14, 2021

Could you please propose a better solution @peter-gergely-horvath ? Maybe find a few examples of other sites where things are more intutitive? I think we are so used to it, that we do not see it as a problem, but you are probably (as a person who had problems with it) the best person to tell us what would be better?

@uranusjr
Copy link
Member

uranusjr commented Jun 14, 2021

I’ve always found the current layout unintuitive. Maybe we can add a single list item under Apache Airflow that says Apache Airflow like the provider packages? That would be a more obvious target to click on.

@uranusjr
Copy link
Member

Something like this

image

@peter-gergely-horvath
Copy link
Author

I could imagine something like this, with "Read the documentation" being a link to the corresponding sub-page:

airflow_documentation_page2

@potiuk
Copy link
Member

potiuk commented Jun 14, 2021

Better indeed. Would you like to make PR with that change ? That might be a nice first contribution and it is very simple to do - just follow this link https://github.com/apache/airflow-site/edit/main/landing-pages/site/content/en/docs/_index.md

@peter-gergely-horvath
Copy link
Author

OK, I've created my first AirFlow pull request :)

apache/airflow-site#434

kaxil pushed a commit to apache/airflow-site that referenced this issue Jun 15, 2021
Co-authored-by: Jarek Potiuk <jarek@potiuk.com>

This fixes apache/airflow#16431
potiuk pushed a commit to apache/airflow-site that referenced this issue Jun 17, 2023
Co-authored-by: Jarek Potiuk <jarek@potiuk.com>

This fixes apache/airflow#16431
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind:bug This is a clearly a bug
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants