From e6347ea187a0749b2ef87b2dd3766f211cfbcb98 Mon Sep 17 00:00:00 2001 From: Robert Sparks Date: Fri, 19 Mar 2021 15:57:44 +0000 Subject: [PATCH] Update the submission instructions to encourage submission of v3 xml. Fixes #3232. Commit ready for merge. - Legacy-Id: 18914 --- ietf/settings.py | 2 ++ .../submit/problem-reports-footer.html | 5 ++-- ietf/templates/submit/tool_instructions.html | 8 +++--- ietf/templates/submit/upload_submission.html | 28 +++++++++---------- 4 files changed, 22 insertions(+), 21 deletions(-) diff --git a/ietf/settings.py b/ietf/settings.py index 4f1561bd0..fcbca66fc 100644 --- a/ietf/settings.py +++ b/ietf/settings.py @@ -550,6 +550,7 @@ INTERNAL_IPS = ( IDTRACKER_BASE_URL = "https://datatracker.ietf.org" RFCDIFF_BASE_URL = "https://www.ietf.org/rfcdiff" IDNITS_BASE_URL = "https://www.ietf.org/tools/idnits" +XML2RFC_BASE_URL = "https://xml2rfc.tools.ietf.org/experimental.html" # The name of the method to use to invoke the test suite TEST_RUNNER = 'ietf.utils.test_runner.IetfTestRunner' @@ -754,6 +755,7 @@ AUDIO_IMPORT_EMAIL = ['ietf@meetecho.com'] IANA_EVAL_EMAIL = "drafts-eval@icann.org" SESSION_REQUEST_FROM_EMAIL = 'IETF Meeting Session Request Tool ' +SECRETARIAT_SUPPORT_EMAIL = "support@ietf.org" SECRETARIAT_ACTION_EMAIL = "ietf-action@ietf.org" SECRETARIAT_INFO_EMAIL = "ietf-info@ietf.org" diff --git a/ietf/templates/submit/problem-reports-footer.html b/ietf/templates/submit/problem-reports-footer.html index faa48af02..35c17ddfc 100644 --- a/ietf/templates/submit/problem-reports-footer.html +++ b/ietf/templates/submit/problem-reports-footer.html @@ -7,7 +7,8 @@

- If you need to request manual posting of an Internet-Draft, please send the - draft and the reason for manual posting to idsubmission@ietf.org. + If you run into problems submitting an Internet-Draft and need to request manual posting of an Internet-Draft, please send the + draft and the reason for manual posting to {{settings.SECRETARIAT_SUPPORT_EMAIL}}. + Be advised that manual processing always takes additional time.

diff --git a/ietf/templates/submit/tool_instructions.html b/ietf/templates/submit/tool_instructions.html index 9b9d8b5f5..d275f830d 100644 --- a/ietf/templates/submit/tool_instructions.html +++ b/ietf/templates/submit/tool_instructions.html @@ -38,18 +38,18 @@

Upload screen

- The Upload screen is the first screen that a user will see when he or she starts the I-D submission process. A user can submit four different formats of an I-D, plain text, XML, PDF, and postscript, at the same time. Failure to submit at least one of a plain-text or xml version will cause an error, and an error screen will be displayed. + The Upload screen is the first screen that a user will see when he or she starts the I-D submission process. A user can submit four different formats of an I-D, plain text, XML, PDF, and postscript, at the same time. Failure to submit at least one of a plain-text or xml version will cause an error, and an error screen will be displayed. A single v3 .xml source is preferred. A single v2 .xml source will be accepted. If neither of those are available, a plain-text document may be provided.

By submitting your I-D, you are granting some rights to the IETF Trust. Before you submit your I-D, - review the information on the NOTE WELL tab and BCP 78, + review the information on the NOTE WELL tab and BCP 78, "Rights Contributors Provide to the IETF Trust".

Before you submit your I-D, it is recommended that you check it for nits - using the idnits tool. + using the idnits tool.

@@ -165,7 +165,7 @@ {% include "submit/problem-reports-footer.html" %}

- The specification for this tool can be found in RFC 4228. + The specification for this tool can be found in RFC 4228.

{% endblock %} diff --git a/ietf/templates/submit/upload_submission.html b/ietf/templates/submit/upload_submission.html index deec285b2..f06e60a4a 100644 --- a/ietf/templates/submit/upload_submission.html +++ b/ietf/templates/submit/upload_submission.html @@ -21,22 +21,15 @@ {% endif %} {% if not form.shutdown or user|has_role:"Secretariat" %} -

If you run into problems when submitting an Internet-Draft - using this and the following pages, you may alternatively submit - your draft by email to - internet-drafts@ietf.org. - However, be advised that manual processing always takes additional time. -

-

By submitting your I-D, you are granting some rights to the IETF Trust. Before you submit your I-D, - review the information on the NOTE WELL tab and BCP 78, + review the information on the NOTE WELL tab and BCP 78, "Rights Contributors Provide to the IETF Trust".

Before you submit your I-D, it is recommended that you check it for nits - using the idnits tool. + using the idnits tool.

{% include "submit/problem-reports-footer.html" %} @@ -45,14 +38,19 @@

- Either a plain-text document or a valid .xml file which can be processed by the xml2rfc - processor must be provided. + The best way to submit an Internet-Draft is to provide a single v3 .xml source file. + The datatracker will generate the .txt and other formats from that file.
- For v3 .xml sources which include external files, this requires them to be run through xml2rfc with - the --expand option, to produce a completely expanded (standalone) .xml source file for - upload. + Source v3 .xml which include external files must be preprocessed through xml2rfc with + the --expand option, to produce a completely expanded (standalone) .xml source + file for upload.
- If no .txt file is provided, one will be generated from the .xml file. + The online conversion tool can be used to + convert v2 .xml documents to v3. +
+ A single v3 .xml source is preferred. A single v2 .xml source will be accepted. If + neither of those are available, a plain-text document may be provided. One of these + three options must be provided.
Other file types are optional.