Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: clarify replace wording #8244

Merged
merged 12 commits into from
Dec 5, 2024
Merged

fix: clarify replace wording #8244

merged 12 commits into from
Dec 5, 2024

Conversation

ghwood
Copy link
Contributor

@ghwood ghwood commented Nov 20, 2024

No description provided.

ghwood and others added 11 commits November 12, 2024 13:49
Update help text In the "Replacement Information" section of
the "Status" tab
Clarify "Replace" in I-D submission form
* chore: update dependencies

* fix: eslint + neostandard

* fix: add corepack prompt env var to init script

* docs: Update README.md

---------

Co-authored-by: Robert Sparks <rjsparks@nostrum.com>
update quote syntax issue on previous update help text In the "Replacement Information" section of the "Status" tab to fix ietf-tools#8059
fix: clarify "Replace" in I-D submission form ietf-tools#8205
@rjsparks
Copy link
Member

Thanks for pushing on this. Some thoughts below:

An I-D submission will be automatically attached to the previous version of the I-D with the same name, or assigned "-00" version if no previous version exists. If this submission is intended to replace an I-D with a different name (e.g. when an individual I-D is adopted as a Working Group document), please enter that name here. (Approval required to replace an I-D for which you are not an author.)

The first sentence doesn't work for me - it sees to imply "-00" is a thing that happens at this point, but -00 was chosen by the submitter long before the submitter gets to this form.

I also don't think "automatically attached to a previous" is what happens, or is the right model of what's happening for other people to build. Instead, we need to reinforce that there are versions of an Internet-Draft, and that an Internet-Draft might get replaced with some other Internet-Draft(s).

Maybe imperative statements rather than explanation would work better? My alternate suggestion:


Do not enter anything here if you are only submitting the next version of your Internet-Draft. Only enter items here if this submission is intended to replace an I-D with a different name. A typical use of this field is to note what individual I-Ds are replaced by a new -00 Working group I-D. Note that additional approval will be required to replace an I-D for which you are not an author.

@rjsparks rjsparks merged commit 64c5ef1 into ietf-tools:main Dec 5, 2024
6 of 7 checks passed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 9, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants