question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

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

See original GitHub issue

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:

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Comments:7 (4 by maintainers)

github_iconTop GitHub Comments

2reactions
peter-gergely-horvathcommented, Jun 14, 2021

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

airflow_documentation_page2

1reaction
peter-gergely-horvathcommented, Jun 15, 2021

OK, I’ve created my first AirFlow pull request 😃

https://github.com/apache/airflow-site/pull/434

Read more comments on GitHub >

github_iconTop Results From Across the Web

Fix Word documents missing header and footer areas - YouTube
Has Word stopped displaying the white space between the end of one page and the start of the next? In this video, I...
Read more >
How to use headings on your site - Yoast
Headings help users and search engines to read and understand text. For example, they act as signposts for the readers and make it...
Read more >
How to Create a Link to Jump to a Specific Part of a Page ...
1. Name the object or text you want to link to. In a normal linking scenario, whatever you need to link to has...
Read more >
Video: Create accessible links in Word - Microsoft Support
Create a more meaningful hyperlink · Copy the link you want to work with into a Word document and turn it into a...
Read more >
Cross-referencing with Sphinx - Read the Docs
Links can be verbose and hard to read, so it is unclear what page/section they are ... You can cross reference more than...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found