apache/airflow

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

Open

#16,654 opened on Jun 25, 2021

View on GitHub
 (18 comments) (0 reactions) (0 assignees)Python (16,781 forks)batch import
good first issuekind:bugkind:documentationneeds-triagepinned

Repository metrics

Stars
 (44,809 stars)
PR merge metrics
 (Avg merge 7d 18h) (834 merged PRs in 30d)

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

Also, I think the button is way too big and it makes "difficult" to read the documentation

Contributor guide

Research direction
Examine the documentation build configuration to understand how the 'Suggest a change on this page' button generates its URL. Check for any recent changes in the sphinx configuration or theme that might have broken the link. Also look at the CSS responsible for the button size and consider making it smaller or using a more subtle design.
Tech stack
python
Domain
documentation
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitBasic HTML/CSS
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70