Skip to content

Commit de5d7da

Browse files
authored
Merge pull request #9293 from readthedocs/agj/dev-docs-updates
Update mentions of our roadmap to be current
2 parents 0f04b46 + 6b32291 commit de5d7da

File tree

2 files changed

+28
-77
lines changed

2 files changed

+28
-77
lines changed

docs/dev/issue-labels.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,8 @@ what they stand for.
1313
Pull requests could be delayed or closed if the pull request doesn't align
1414
with our current roadmap. An issue or pull request that has not been
1515
accepted should either eventually move to an accepted state, or should be
16-
closed. As an issue is accepted, we will find room for it on our roadmap,
17-
either on an upcoming release (point release milestones), or on a future
18-
milestone project (named milestones).
16+
closed. As an issue is accepted, we will find room for it on our roadmap or
17+
roadmap backlog.
1918

2019
*Bug*
2120
An issue describing unexpected or malicious behaviour of the readthedocs.org

docs/dev/roadmap.rst

Lines changed: 26 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,21 @@ Roadmap
44
Process
55
-------
66

7-
Read the Docs has adopted the following workflow with regards to how we
8-
prioritize our development efforts and where the core development team focuses
9-
its time.
7+
We publicly organize our product roadmap, on our `Roadmap`_ on GitHub project.
8+
Here, you will find several views into our roadmap:
9+
10+
`Current sprint <https://github.com/orgs/readthedocs/projects/156/views/1>`_
11+
Work that core team is currently responsible for.
12+
13+
`Backlog <https://github.com/orgs/readthedocs/projects/156/views/4>`_
14+
Work that we have planned for future sprints. Items with an assigned
15+
timeframe have generally been discussed already by the team. Iteams that do
16+
not yet have a timeframe assigned are not yet a priority of the core team.
17+
18+
The focus of the core team will be on roadmap and sprint items. These items are
19+
promoted from our backlog before each sprint begins.
20+
21+
.. _Roadmap: https://github.com/orgs/readthedocs/projects/156/views/1
1022

1123
Triaging issues
1224
~~~~~~~~~~~~~~~
@@ -17,84 +29,24 @@ summarize the important pieces:
1729
* New issues coming in will be triaged, but won't yet be considered part of our
1830
roadmap.
1931
* If the issue is a valid bug, it will be assigned the ``Accepted`` label and
20-
will be prioritized, likely on an upcoming point release.
21-
* If the issues is a feature or improvement, the issue might go through a design
22-
decision phase before being accepted and assigned to a milestone. This is a
32+
will be prioritized, likely on an upcoming release.
33+
* If the issues are a feature or improvement, the issue might go through a design
34+
decision phase before being accepted and assigned to our roadmap. This is a
2335
good time to discuss how to address the problem technically. Skipping this
2436
phase might result in your PR being blocked, sent back to design decision, or
2537
perhaps even discarded. It's best to be active here before submitting a PR for
2638
a feature or improvement.
2739
* The core team will only work on accepted issues, and will give PR review
28-
priority to accepted issues. Pull requests addressing issues that are not on
29-
our roadmap are welcome, but we cannot guarantee review response, even for
30-
small or easy to review pull requests.
31-
32-
Milestones
33-
~~~~~~~~~~
34-
35-
We maintain two types of milestones: point release milestones for our upcoming
36-
releases, and group milestones, for blocks of work that have priority in the
37-
future.
38-
39-
Generally there are 2 or 3 point release milestones lined up. These point
40-
releases dictate the issues that core team has discussed as priority already.
41-
Core team should not focus on issues outside these milestones as that implies
42-
either the issue was not discussed as a priority, or the issue isn't a priority.
43-
44-
We follow `semantic versioning`_ for our release numbering and our point release
45-
milestones follow these guidelines. For example, our next release milestones
46-
might be ``2.8``, ``2.9``, and ``3.0``. Releases ``2.8`` and ``2.9`` will
47-
contain bug fix issues and one backwards compatible feature (this dictates the
48-
change in minor version). Release ``3.0`` will contain bugfixes and at least one
49-
backwards incompatible change.
50-
51-
Point release milestones try to remain static, but can shift upwards on a
52-
release that included an unexpected feature addition. Sometimes the resulting PR
53-
unexpectedly includes changes that dictate a minor version increment though,
54-
according to `semantic versioning`_. In this case, the current milestone is
55-
closed, future milestones are increased a minor point if necessary, and the
56-
remaining milestone issues are migrated to a new milestone for the next upcoming
57-
release number.
58-
59-
Group milestones are blocks of work that will have priority in the future, but
60-
aren't included on point releases yet. When the core team does decide to make
61-
these milestones a priority, they will be moved into point release milestones.
62-
63-
.. _semantic versioning: https://semver.org
40+
priority to accepted roadmap/sprint issues. Pull requests addressing issues
41+
that are not on our roadmap are welcome, but we cannot guarantee review
42+
response, even for small or easy to review pull requests.
6443

6544
Where to contribute
6645
~~~~~~~~~~~~~~~~~~~
6746

68-
It's best to pick off an issue from our current point release or group
69-
milestones, to ensure your pull request gets attention. You can also feel free
70-
to contribute on our Cleanup or Refactoring milestones. Though not a development
71-
priority, these issues are generally discrete, easier to jump into than feature
72-
development, and we especially appreciate outside contributions here as these
73-
milestones are not a place the core team can justify spending time in
74-
development currently.
75-
76-
Current roadmap
77-
---------------
78-
79-
In addition to the point release milestones currently established, our current
80-
roadmap priorities also include:
81-
82-
Admin UX
83-
https://github.com/readthedocs/readthedocs.org/milestone/16
84-
85-
Search Improvements
86-
https://github.com/readthedocs/readthedocs.org/milestone/23
87-
88-
YAML File Completion
89-
https://github.com/readthedocs/readthedocs.org/milestone/28
90-
91-
There are also several milestones that are explicitly *not* a priority for the
92-
core team:
93-
94-
Cleanup
95-
https://github.com/readthedocs/readthedocs.org/milestone/10
96-
97-
Refactoring
98-
https://github.com/readthedocs/readthedocs.org/milestone/34
47+
It's best to pick off issues from our roadmap, and specifically from `our backlog`_,
48+
to ensure your pull request gets attention. If you find an issue that is not
49+
currently on our roadmap, we suggest asking about the priority of the issue. In
50+
some cases, we might put the issue on our roadmap to give it priority.
9951

100-
Core team will not be focusing their time on these milestones in development.
52+
.. _our backlog: https://github.com/orgs/readthedocs/projects/156/views/4

0 commit comments

Comments
 (0)