rpc_github_roadmap
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| rpc_github_roadmap [2025/07/16 22:50] – added project links jmahoney | rpc_github_roadmap [2026/02/12 05:44] (current) – external edit 127.0.0.1 | ||
|---|---|---|---|
| Line 5: | Line 5: | ||
| The RPC currently uses a file system for storing documents that they are editing and a manual process for creating diffs (for details, see the [[current_file_mgmt|Current File Management, Issue Tracking, and Version Control]] page). The tools modernization plan includes incorporating git and GitHub for version control. | The RPC currently uses a file system for storing documents that they are editing and a manual process for creating diffs (for details, see the [[current_file_mgmt|Current File Management, Issue Tracking, and Version Control]] page). The tools modernization plan includes incorporating git and GitHub for version control. | ||
| - | ===== Phase 1: Private repos for version control and publication support (in design) ===== | + | ===== Phase 0: Minimal GitHub support |
| + | |||
| + | Phase 0 is an optional pilot program where the RPC will create a document repo for authors who wish to use GitHub' | ||
| + | |||
| + | ==== Repo Creation ==== | ||
| + | |||
| + | At the start of AUTH48, the RPC will manually create a repo using a template with the approved source file that entered the queue, which can be in either RFCXML or kramdown-rfc format. This file will be committed to the " | ||
| + | |||
| + | The RPC will then create a " | ||
| + | |||
| + | ==== Editor and author interactions ==== | ||
| + | |||
| + | Both authors and RPC editors will work in the PR, using the [[https:// | ||
| + | Specifically, | ||
| + | * [[https:// | ||
| + | * [[https:// | ||
| + | |||
| + | The suggestion feature of the PR review can be used to tweak edits made in the branch. For larger edits, such as making terminology consistent throughout the document, an author can indicate how to make the update in a review or issue comment, and the RPC will commit those updates to the " | ||
| + | |||
| + | The PR is merged when no issues remain. As is done currently, authors will provide their final approval of the document via email. If the source file is kramdown-rfc, | ||
| + | |||
| + | If the authors want to make changes unrelated to the RPC's edits, they will need to create their own PR, which may need to be approved by the stream manager via email, depending on whether the changes are beyond editorial. | ||
| + | |||
| + | Once the document and outputs are approved, the RPC will copy the final source document to their file system to complete their publication procedures. | ||
| + | |||
| + | ==== Requirements for entering Phase 0 ==== | ||
| + | |||
| + | * Create a repo template (in progress) | ||
| + | * Refresh GitHub training for editors (in progress) | ||
| + | * Fine-tune AUTH48 procedures and instructions to authors (in progress) | ||
| + | * Experimentation with a few documents first before opening the process more widely (in progress) | ||
| + | |||
| + | Rollout: November 2025 | ||
| + | |||
| + | ===== Phase 1: Internal | ||
| For the first phase of working with GitHub, document repos will remain private as the RPC implements and refines their internal processes for version control and publication. | For the first phase of working with GitHub, document repos will remain private as the RPC implements and refines their internal processes for version control and publication. | ||
| Line 33: | Line 67: | ||
| === Issue Tracking === | === Issue Tracking === | ||
| - | Questions and issues between editors can be added to the repo's issue tracker. For questions that involve suggested text, an editor can create a pull request against the working branch showing the changes. However, questions to authors will continue to be placed in the document so the authors can see the questions as they review the source file. These questions | + | Questions and issues between editors can be added to the repo's issue tracker. For questions that involve suggested text, an editor can create a pull request against the working branch showing the changes. However, questions to authors will continue to be placed in the document so the authors can see the questions as they review the source file. An editor |
| ==== AUTH48 ==== | ==== AUTH48 ==== | ||
| Line 55: | Line 89: | ||
| The publishing editor reviews the pre-pub PR and makes any other updates. Occasionally, | The publishing editor reviews the pre-pub PR and makes any other updates. Occasionally, | ||
| - | The publishing editor invokes a set of publication GitHub actions to run the preptool, and to place files and data with various services (rfc-editor.org, | + | The publishing editor |
| + | |||
| + | Once an RFC is published, its repo is archived. | ||
| ==== Requirements for entering Phase 1 ==== | ==== Requirements for entering Phase 1 ==== | ||
| Line 61: | Line 97: | ||
| * DraftForge with following features: GitHub support, XML validation (in progress) | * DraftForge with following features: GitHub support, XML validation (in progress) | ||
| * DraftForge training for editors (todo) | * DraftForge training for editors (todo) | ||
| - | * Purple integration with GitHub (todo) | + | * Purple integration with GitHub (in progress) |
| * GitHub actions created and functioning (todo) | * GitHub actions created and functioning (todo) | ||
| * Refresh GitHub training for editors (todo) | * Refresh GitHub training for editors (todo) | ||
| + | * Migrate from the current file system to GitHub repos | ||
| + | |||
| + | Estimated rollout timeframe: Spring 2026 | ||
| ===== Phase 2: Collaborating with authors during AUTH48 (todo) ===== | ===== Phase 2: Collaborating with authors during AUTH48 (todo) ===== | ||
| Line 79: | Line 118: | ||
| A PR created by an author will be reviewed by an editor. If there are no issues, the editor will merge it. If the changes are beyond editorial, the editor will ask the stream approver to review and review the PR. | A PR created by an author will be reviewed by an editor. If there are no issues, the editor will merge it. If the changes are beyond editorial, the editor will ask the stream approver to review and review the PR. | ||
| - | Once all PRs are merged and the authors have approved the document, the publication process continues as described in the first phase. An action will be available to help the authors merge the RPC's edits into their document repo if they have one so they can have both their repo's history and the RPC repo's history of their document. | + | Once all PRs are merged and the authors have approved the document, the publication process continues as described in the first phase. An action will be available to help the authors merge the RPC's edits into their document repo if they have one so they can have both their repo's history and the RPC repo's history of their document |
| ==== Requirements for entering Phase 2 ==== | ==== Requirements for entering Phase 2 ==== | ||
| Line 87: | Line 126: | ||
| * Experimentation with a few documents first before opening more widely (todo) | * Experimentation with a few documents first before opening more widely (todo) | ||
| + | Estimated rollout timeframe: Late Summer 2026 | ||
| ---- | ---- | ||
rpc_github_roadmap.1752706209.txt.gz · Last modified: (external edit)