kubernetes-client/python

docs: Switch to MyST from recommonmark

Open

#1,810 opened on May 31, 2022

View on GitHubContributor guide
 (4 comments) (1 reaction) (0 assignees)Python (3,323 forks)batch import
help wantedkind/documentationlifecycle/stale

Repository metrics

Stars
 (6,225 stars)
PR merge metrics
 (Avg merge 10d 3h) (2 merged PRs in 30d)

Description

Warning: recommonmark is now deprecated. We recommend using MyST for a docutils bridge going forward. See this issue for background and discussion.

Contributor guide

Research direction
Migrate the documentation build configuration from recommonmark to MyST Parser by updating the Sphinx configuration file and adjusting any markdown files if needed.
Tech stack
python
Domain
documentationdeveloper experience
Issue type
Documentation
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
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65