User Tools

Site Tools


rpc_github_roadmap

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
rpc_github_roadmap [2026/08/03 16:02] – updated Intro jmahoneyrpc_github_roadmap [2026/08/20 19:20] (current) – Added an FAQ jmahoney
Line 7: Line 7:
 ===== Phase 0: Minimal GitHub support for Final Review (in progress) ===== ===== Phase 0: Minimal GitHub support for Final Review (in progress) =====
  
-Phase 0 is an optional pilot program where the RPC will create a document repo for authors who wish to use GitHub's review functionality for Final Review. +Phase 0 is an optional pilot program where the RPC will create a document repo for authors who wish to use GitHub's review functionality for Final Review. This phase was designed after [[https://datatracker.ietf.org/meeting/interim-2025-rpc-07/session/rpc|discussion with the community in Sept 2025]].
  
 ==== Repo Creation ==== ==== Repo Creation ====
Line 17: Line 17:
 ==== Editor and author interactions ==== ==== Editor and author interactions ====
  
-Both authors and RPC editors will work in the PR, using the [[https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests.|review tools provided by GitHub]].+Both authors and RPC editors will work in the PR, using the [[https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests|review tools provided by GitHub]].
 Specifically,  Specifically, 
   * [[https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request|Reviewing proposed changes in a pull request]]   * [[https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request|Reviewing proposed changes in a pull request]]
Line 57: Line 57:
 ==== Editor Interactions ==== ==== Editor Interactions ====
  
-The RPC editors will interact with the GitHub repo using [[https://github.com/ietf-tools/editor/|DraftForge]], the editing software created by the Tools Team. The editor will clone the repository locally, make changes to the document, commit those changes to their branches, and create pull requests through DraftForge.+The RPC editors will interact with the GitHub repo using [[https://github.com/ietf-tools/draftforge|DraftForge]], the editing software created by the Tools Team. The editor will clone the repository locally, make changes to the document, commit those changes to their branches, and create pull requests through DraftForge.
  
-Editors will work in branches that they have created from main, making small commits as they work. They will create pull requests on GitHub when they have completed their work on the document for the next editor in the editing process to review. The document is first edited by the Document Specialist, who does formatting, then the Citation Specialist, who checks references and links, and the Primary Editor (PE), who copyedits the document.+Editors will work in branches that they have created from main, making small commits as they work. They will create pull requests on GitHub when they have completed their work on the document for the next editor in the editing process to review. The document is first edited by the Document Specialist, who does formatting, then the Citation Specialist, who checks references and links, and the First Editor (also known as a Primary Editor or PE), who copyedits the document.
  
 The PE will review the pull requests created by the Document and Citation Specialists and merge them into main when the PE is satisfied with the updates. The PE then creates branches off main for their own edits. The PE will review the pull requests created by the Document and Citation Specialists and merge them into main when the PE is satisfied with the updates. The PE then creates branches off main for their own edits.
  
-When the PE is done, RFC Editor (RE) will review the PE's pull requests. The RE will merge the PRs into main when their review is complete. The RE will then create branches from main for their own edits. When they have completed their editing work, they will merge their branches into main.+When the PE is done, the Second Editor (also known as an RFC Editor or RE) will review the PE's pull requests. The RE will merge the PRs into main when their review is complete. The RE will then create branches from main for their own edits. When they have completed their editing work, they will merge their branches into main.
  
 === Issue Tracking === === Issue Tracking ===
Line 127: Line 127:
  
 Estimated rollout timeframe: Fall 2026 Estimated rollout timeframe: Fall 2026
 +
 +
 +===== Frequently Asked Questions =====
 +
 +**Q:** Why doesn't the RPC fork the working group's repo?
 +
 +**A:** The use of GitHub and its features is not consistent across working groups. A working group may not even have a GitHub repo. Some working groups place all their drafts in one repo, others construct repos for each document. Some working groups use repos that belong to the authors. Working groups will differ in their processes and how they use GitHub features. For example, some repos use actions, some don't. The RPC cannot know the status and processes for each repo that has been used for the documents that have entered the RFC Editor queue.
 +
 +
 +**Q:** But isn't the RPC's repo redundant with the document's repo?
 +
 +**A:** The RPC's repos are separate from the document's working repo. The RPC's repos support the RPC's editing and publication work. Each RPC repo contains configurations for editing tools and files that support integration with the queue management system and publication automation. When an RFC is published, the repo serves as the archive of the published files.
 +
  
 ---- ----
rpc_github_roadmap.1785772964.txt.gz · Last modified: by jmahoney

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki