User Tools

Site Tools


pilot_test_kramdown_rfc

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
pilot_test_kramdown_rfc [2025/12/16 19:43] – trial is longer than 3 months jmahoneypilot_test_kramdown_rfc [2026/08/06 19:36] (current) – how to inline includes jmahoney
Line 1: Line 1:
-====== RPC Pilot Test: Editing and AUTH48 in kramdown-rfc ======+====== RPC Pilot Test: Editing and Final Review in kramdown-rfc ======
  
-Currently, the RFC Production Center (RPC) only accepts and edits RFCXML files.  However, a larger portion of the authoring community is using kramdown-rfc to create their Internet-Drafts.  As such, the RPC will offer editing in kramdown-rfc and will pilot test AUTH48 starting 1 September 2025.  +Currently, the RFC Production Center (RPC) only accepts and edits RFCXML files.  However, a larger portion of the authoring community is using kramdown-rfc to create their Internet-Drafts.  As such, the RPC will offer editing in kramdown-rfc and will pilot test Final Review (formerly called AUTH48) starting 1 September 2025.  
  
 The goal is to further support the authoring community and facilitate author reviews using the format they are familiar with.  We expect that editing in kramdown-rfc will result in cleaner diffs that focus on content changes.  This is also an early step toward supporting the growing portion of the authoring community that collaborates in GitHub and that uses kramdown-rfc to take advantage of GitHub features.   The goal is to further support the authoring community and facilitate author reviews using the format they are familiar with.  We expect that editing in kramdown-rfc will result in cleaner diffs that focus on content changes.  This is also an early step toward supporting the growing portion of the authoring community that collaborates in GitHub and that uses kramdown-rfc to take advantage of GitHub features.  
  
-To start, the RPC will accept at least 5 kramdown-rfc requests per month. The RPC will ask authors if they want to participate when their document enters the queue. If so, then RPC will do the following: +To start, the RPC will accept at least 5 kramdown-rfc requests per month. The RPC will ask authors if they want to participate when their document enters the queue. Note that, at this time, all kramdown-rfc files must be self-contained. That is, any ''{::include }'' macros must be replaced with the text that they point to. Files can be placed inline by using the following commands: 
 + 
 +<code> 
 +   kramdown-rfc mydraft.md >mydraft.xml 
 +   kramdown-rfc-extract-markdown mydraft.xml >mydraft-files-inline.md  
 +</code> 
 + 
 +If authors want to participate, then RPC will do the following: 
   * accept the author's kramdown-rfc file   * accept the author's kramdown-rfc file
   * edit in the kramdown-rfc file    * edit in the kramdown-rfc file 
-  * process AUTH48 in kramdown-rfc  +  * process Final Review in kramdown-rfc  
-  * convert the kramdown-rfc to RFCXML once the authors have approved the content +  * convert the kramdown-rfc to RFCXML once the authors have indicated the file is ready to be converted to XML  
-  * request a second approval for the RFC in its final form after making any formatting adjustments, as needed+  * request approval of the RFC in its final form after making any formatting adjustments, as needed
   * archive the kramdown-rfc file for authors of future bis documents   * archive the kramdown-rfc file for authors of future bis documents
  
-Once the authors approve the content, the RPC will convert the file to RFCXML.  Note that some additional conversion updates may be required (e.g., implementing displayreference and tweaking indentation in RFCXML).  Once the RPC has updated the RFCXML format as needed, the authors will be asked to approve the RFC in its final form.  +When the RPC converts the file to RFCXML, some additional updates may be required (e.g., implementing displayreference and tweaking indentation in RFCXML).  Once the RPC has updated the RFCXML format as needed, the authors will be asked to approve the RFC in its final form.  
  
-We expect to pilot this while we hone the AUTH48 process. As we have done very few AUTH48s in kramdown-rfc to date, we thank you in advance for your patience while we work through the process kinks.  +We expect to pilot this while we hone the Final Review process. As we have done very few Final Reviews in kramdown-rfc to date, we thank you in advance for your patience while we work through the process kinks.  
  
 Once the trial period has completed, we expect to begin accepting requests for editing in kramdown-rfc without restriction.  Once the trial period has completed, we expect to begin accepting requests for editing in kramdown-rfc without restriction. 
pilot_test_kramdown_rfc.1765914227.txt.gz · Last modified: (external edit)

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki