Roadmap
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- markdown, r, yaml
- Domain
- documentation
Research direction
Start with the _pkgdown.yml roadmap configuration described in the issue and compare the linked stan-dev/loo pull request 396. Trace how this pkg currently handles website templates and how an Rmd document could be integrated without emitting HTML. Done means an opt-in roadmap supports milestone and issue overrides, exclusions, ordering, and closed-issue marking.
Written by the indexing model from the issue text.
Description
Add a roadmap template like @florence-bockting did for loo: https://github.com/stan-dev/loo/pull/396
This pkg should read a roadmap section in _pkgdown.yml and support overrides per issue for custom descriptions, same for milestones.
Internally the cleanest way of doing this might be to build a custom Rmd which is styled automatically and to wire in some custom classes as needed from Florence's PR. That way actual rendering is purely pkgdown's purview. That is, this pkg shouldn't emit HTML.
Example template:
roadmap:
enabled: true
format: "rmd" # in the future support writing a "qmd"
overrides:
milestones:
# milestone numbers, not their titles, for stable IDs.
"1":
title: "Version 3.0"
description: >
Custom release-level prose.
issues:
# similarly, issue numbers for stable ID
"123":
description: >
Custom issue-level prose.
exclude:
labels:
- "internal*"
- "wontfix"
- "invalid"
issues:
- "124"
- "456"
This would require pkgs to opt-in, would exclude all PRs, exclude closed milestones, and exclude issues with those labels. Closed issues (which aren't filtered out) in an open milestone should be marked and maybe moved to the end, but otherwise included. Issues will be ordered by issue number.
This would be the default, defined in this pkg, and downstream pkgs could, of course, override as needed. All a typical Stan package would need to get the roadmap is:
roadmap:
enabled: true
Of course, they would have to use milestones/labels as well, but the website part would be handled by this pkg.
- Dominant language
- HTML
- Stars
- 0
- Forks
- 0
- Avg merge
- 21h 23m
- Merged PRs (30d)
- 4
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Similar issues
-
accepting PR Content:HTML
Difficulty 1/5 Under an hour Newbie friendliness 88/100
mdn/content#45988 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
pyca/verified-garbage#1023 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
quickemu-project/quickemu#1960 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100