apache/airflow

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

Open

#16.654 geöffnet am 25. Juni 2021

Auf GitHub ansehen
 (18 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (16.781 Forks)batch import
good first issuekind:bugkind:documentationneeds-triagepinned

Repository-Metriken

Stars
 (44.809 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 7T 18h) (834 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Untersuche die Schaltfläche 'Änderung vorschlagen' in der Apache Airflow Dokumentation. Die Schaltfläche erscheint auf generierten Dokumentationsseiten und verlinkt auf eine .rst Datei. Die Korrektur umfasst die Berichtigung des Link Pfads und die Verkleinerung der Schaltfläche. Suche die Schaltfläche im Dokumentations Theme (wahrscheinlich eine Sphinx Vorlage) und ändere die URL Generierungslogik. Passe außerdem das CSS an, um die Schaltfläche kleiner zu machen. Überprüfe die Kommentare zum Issue für vorgeschlagene Ansätze.
Tech Stack
python
Domain
documentation
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitBasic HTML/CSS
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70