apache / apache/airflow

"Suggest a change on this page" button bug/change request

Closed
#16,654 20 comments 0 reactions 0 assignees View on GitHub
good first issue kind:bug kind:documentation needs-triage pinned
Dominant language
Python
Stars
46.9k
Forks
17.8k
Avg merge
2d 7h
Merged PRs (30d)
484

Description

Coming from google to the following web: https://airflow.apache.org/docs/apache-airflow-providers-amazon/stable/_api/airflow/providers/amazon/aws/hooks/s3/index.html

The button 'Suggest a change on this page' doesn't work, it leads you to https://github.com/apache/airflow/edit/main/docs/apache-airflow-providers-amazon/_api/airflow/providers/amazon/aws/hooks/s3/index.rst
Captura de pantalla 2021-06-25 a las 14 36 56

Also, I think the button is way too big and it makes "difficult" to read the documentation
Captura de pantalla 2021-06-25 a las 14 38 04

Contributor guide

Open the contributing guide

Research direction

Start with the generated S3 hook documentation at the reported URL and the source path docs/apache-airflow-providers-amazon/_api/airflow/providers/amazon/aws/hooks/s3/index.rst. Trace how the “Suggest a change on this page” link is generated, then check the documentation presentation around that button. Done means the link reaches the correct editable source and the button no longer obscures the documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.