canonical/cloud-init

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

Open

#4,331 opened on Aug 10, 2023

View on GitHubContributor guide
 (2 comments) (0 reactions) (0 assignees)Python (1,108 forks)auto 404
documentationenhancementhacktoberfest

Repository metrics

Stars
 (3,772 stars)
PR merge metrics
 (PR metrics pending)

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

Contributor guide

Research direction
Investigate the JavaScript code handling keyboard events on the documentation page, specifically for tab switching and scrolling, then update event listeners to map up/down keys to page scroll and left/right keys to tab switching.
Tech stack
pythonhtmlcssjavascript
Domain
documentationfrontend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
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
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90