altf4arnold/datatracker
1
0
Fork 0
Code Issues Pull requests Actions 3 Packages Projects Releases Wiki Activity

Merged in [18914] from rjsparks@nostrum.com:

Browse source 
Update the submission instructions to encourage submission of v3 xml. Fixes #3232.
 - Legacy-Id: 18926
Note: SVN reference [18914] has been migrated to Git commit e6347ea187
This commit is contained in:
Robert Sparks 2021-03-30 14:06:30 +00:00
parent 481fc3ff9d e6347ea187
commit 4fc2283183
4 changed files with 22 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
ietf/settings.py
View file

@ -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 <session-request@ietf.org>'
SECRETARIAT_SUPPORT_EMAIL = "support@ietf.org"
SECRETARIAT_ACTION_EMAIL = "ietf-action@ietf.org"
SECRETARIAT_INFO_EMAIL = "ietf-info@ietf.org"

5
ietf/templates/submit/problem-reports-footer.html
View file

@ -7,7 +7,8 @@
</p>
<p>
If you need to request manual posting of an Internet-Draft, please send the
draft and the reason for manual posting to <a href="mailto:idsubmission@ietf.org">idsubmission@ietf.org</a>.
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 <a href="mailto:{{settings.SECRETARIAT_SUPPORT_EMAIL}}">{{settings.SECRETARIAT_SUPPORT_EMAIL}}</a>.
Be advised that manual processing always takes additional time.
</p>

8
ietf/templates/submit/tool_instructions.html
View file

@ -38,18 +38,18 @@
<h3>Upload screen</h3>
<p>
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.
</p>
<p>
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 <a href="https://tools.ietf.org/html/bcp78">BCP 78</a>,
review the information on the NOTE WELL tab and <a href="{% url 'ietf.doc.views_doc.document_html' name='rfc5378' %}">BCP 78</a>,
"Rights Contributors Provide to the IETF Trust".
</p>
<p>
Before you submit your I-D, it is recommended that you check it for nits
using the <b><a href="https://tools.ietf.org/tools/idnits/">idnits tool</a></b>.
using the <b><a href="{{settings.IDNITS_BASE_URL}}">idnits tool</a></b>.
</p>
<p>
@ -165,7 +165,7 @@
{% include "submit/problem-reports-footer.html" %}
<p>
The specification for this tool can be found in <a href="https://www.ietf.org/rfc/rfc4228.txt?number=4228">RFC 4228</a>.
The specification for this tool can be found in <a href="{% url 'ietf.doc.views_doc.document_html' name='rfc4228' %}">RFC 4228</a>.
</p>
{% endblock %}

28
ietf/templates/submit/upload_submission.html
View file

@ -21,22 +21,15 @@
{% endif %}
{% if not form.shutdown or user|has_role:"Secretariat" %}
<p>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
<a href="mailto:internet-drafts@ietf.org">internet-drafts@ietf.org</a>.
However, be advised that manual processing always takes additional time.
</p>
<p>
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 <a href="https://tools.ietf.org/html/bcp78">BCP 78</a>,
review the information on the NOTE WELL tab and <a href="{% url 'ietf.doc.views_doc.document_html' name='rfc5378' %}">BCP 78</a>,
"Rights Contributors Provide to the IETF Trust".
</p>
<p>
Before you submit your I-D, it is recommended that you check it for nits
using the <b><a href="https://tools.ietf.org/tools/idnits/">idnits tool</a></b>.
using the <b><a href="{{settings.IDNITS_BASE_URL}}">idnits tool</a></b>.
</p>
{% include "submit/problem-reports-footer.html" %}
@ -45,14 +38,19 @@
<p>
<i>
Either a plain-text document or a valid .xml file which can be processed by the xml2rfc
processor <b>must</b> 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.
<br/>
For v3 .xml sources which include external files, this requires them to be run through xml2rfc with
the <tt>--expand</tt> 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 <tt>--expand</tt> option, to produce a completely expanded (standalone) .xml source
file for upload.
<br/>
If no .txt file is provided, one will be generated from the .xml file.
The <a href="{{settings.XML2RFC_BASE_URL}}">online conversion tool</a> can be used to
convert v2 .xml documents to v3.
<br/>
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 <b>must</b> be provided.
<br/>
Other file types are optional.
</i>