canonical/cloud-init

[docs]: Arrow key and Scroll Behavior on Module Reference

Offen

#4.331 geöffnet am 10.08.2023

Auf GitHub ansehenContributor Guide
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (1.108 Forks)auto 404
documentationenhancementhacktoberfest

Repository-Metriken

Stars
 (3.772 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

Documentation request

[Current Behavior] Down/up arrows can be used to scroll down the page. Once you click a specific tab, (Summary/Config Schema) arrow keys swap to only switching between the tabs (including up/down).

[Desired Behavior] Ideally we'd like to see up/down always handle page scroll, and left/right handle tab swapping on the mods if possible.

Reported from: https://cloudinit.readthedocs.io/en/latest/reference/modules.html

Contributor Guide

Research-Richtung
Untersuchen Sie den JavaScript Code, der Tastaturereignisse auf der Dokumentationsseite behandelt, insbesondere für das Umschalten von Registerkarten und das Scrollen, und aktualisieren Sie dann die Ereignis Listener, um die Pfeiltasten nach oben/unten dem Seiten Scrollen und die Pfeiltasten links/rechts dem Umschalten von Registerkarten zuzuordnen.
Tech Stack
pythonhtmlcssjavascript
Domain
documentationfrontend
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
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
Keine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90