canonical/cloud-init

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

Ouverte

#4 331 ouverte le 10 août 2023

Voir sur GitHubGuide contributeur
 (2 commentaires) (0 réaction) (0 personne assignée)Python (1 108 forks)auto 404
documentationenhancementhacktoberfest

Métriques du dépôt

Stars
 (3 772 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

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

Guide contributeur

Direction de recherche
Examinez le code JavaScript qui gère les événements du clavier sur la page de documentation, en particulier pour le changement d'onglets et le défilement, puis mettez à jour les écouteurs d'événements pour mapper les touches haut/bas au défilement de la page et les touches gauche/droite au changement d'onglets.
Stack technique
pythonhtmlcssjavascript
Domaine
documentationfrontend
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90