Re: [rfc-i] Inlining Issue Links in I-D

[Joel Halpern <[e-mail]>]

It is also common for difficult drafts to have an "open issues" section 
of the draft.  Whether to use the draft or github (or both) for such 
things probably varies from WG to WG and even document to document.

Yours,

Joel

On 10/4/2023 4:00 PM, Jean Mahoney wrote:
> Rahul,
>
> On 10/4/23 6:46 AM, Rahul Gupta wrote:
>> Hello again,
>>
>> This is a very specific issue stemming from my conversion to I-D. I 
>> have a few open issues (which will eventually be) in the Github repo 
>> of my draft and I would like to link them from at the very least from 
>> my editor's copy. I am currently doing so by wrapping the issues in a 
>> <cref> and explicitly linking to the Github Issue (footnotes in 
>> kramdown-rfc). Is this the best way to do this?
>
> [JM] The <cref> element [1] allows the author to make editorial 
> comments. Whether the comments are displayed in the output is set with 
> the display attribute (e.g., <cref display="false">). However, I don't 
> know how to hide the equivalent footnotes in kramdown-rfc. The 
> rfc-markdown mailing list would be the place to ask [2].
>
>
>>
>> I am also wondering if there is a culture including issues in a 
>> submitted I-D? 
>
> [JM] Many authors include a section in their I-D that points to the 
> I-D's repo. Authors can include references to GitHub repos [3] and 
> track issues as they wish during I-D development. For example, see [4].
>
>
>> If not, is there a way to keep the issues in the editor's copy and 
>> remove them from the submission in an automated manner?
>
> [JM] I don't know of a GitHub action that currently does that. Maybe 
> someone else has experience with that.
>
>
> Best regards,
> Jean
>
> [1] https://authors.ietf.org/en/rfcxml-vocabulary#cref
> [2] https://www.ietf.org/mailman/listinfo/rfc-markdown
> [3] https://www.rfc-editor.org/styleguide/part2/#ref_repo
> [4] 
> https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-rfc6265bis#name-changes
>
>>
>> Thanks in advance for all the advice,
>>
>> Best Regards
>> Rahul
>>
>>
>>
>> _______________________________________________
>> rfc-interest mailing list
>> [e-mail]
>> https://mailman.rfc-editor.org/mailman/listinfo/rfc-interest
>
> _______________________________________________
> rfc-interest mailing list
> [e-mail]
> https://mailman.rfc-editor.org/mailman/listinfo/rfc-interest