Browse Source

Tweak XEP editor readme to mention Docker

hacx
Sam Whited 6 years ago
parent
commit
f2d595964a
  1. 37
      xep-README.xml

37
xep-README.xml

@ -115,8 +115,20 @@ @@ -115,8 +115,20 @@
</header>
<section1 topic='Overview' anchor='overview'>
<p>The XMPP Extensions Editor (or, for short, XEP Editor) manages the XMPP extensions process as defined in &xep0001;. In addition, the XEP Editor functions as the XMPP Registrar as defined in &xep0053;. Read those documents first, since this README focuses on mechanics instead of philosophy or policy.</p>
<p>Since the inception of the &XSF; in 2001 until early 2014, the &EDITOR; was Peter Saint-Andre. In early 2014, the &XSF; formed a "work team" to dispatch the responsibilities of the XEP Editor and XMPP Registrar. This document describes most of the details about how those responsibilities are performed.</p>
<p>
The XMPP Extensions Editor (or, for short, XEP Editor) manages the XMPP
extensions process as defined in &xep0001;. In addition, the XEP Editor
functions as the XMPP Registrar as defined in &xep0053;. Read those
documents first, since this README focuses on mechanics instead of
philosophy or policy.
</p>
<p>
Since the inception of the &XSF; in 2001 until early 2014, the &EDITOR; was
Peter Saint-Andre. In early 2014, the &XSF; formed a "work team" to
dispatch the responsibilities of the XEP Editor and XMPP Registrar. This
document describes most of the details about how those responsibilities are
performed.
</p>
</section1>
<section1 topic='XEP Editor Responsibilities' anchor='ed'>
@ -160,8 +172,13 @@ @@ -160,8 +172,13 @@
<li>Set the status to Experimental.</li>
<li>Check the file for egregious errors.</li>
<li>Add a reference for the new XEP in the xep.ent file and check those changes into source control.</li>
<li>Log into the webserver, change directories to /home/xsf/xmpp-hg/extensions, type 'hg pull' and 'hg update', and run the "gen.py" script to generate HTML and PDF files.</li>
<li>Log into the webserver, change directories to /home/xsf/xmpp-hg/extensions, type 'hg pull' and 'hg update'.</li>
<li>Run the "archive.sh" script, which copies this published version to <link url='http://xmpp.org/extensions/attic/'>http://xmpp.org/extensions/attic/</link>.</li>
<li>
Run '/docker/xmpp.org_extensions/create.sh' as root, or, if you don't
have root, pester someone on the i-team.
</li>
<li>Wait.</li>
<li>Run the "announce.py" script (see note about <link url='#lists'>List Administration</link>).</li>
<li>Redirect the HTML file in the "inbox" to the new XEP URL (see existing examples on the webserver).</li>
</ol>
@ -175,7 +192,17 @@ @@ -175,7 +192,17 @@
<li>Verify that the version number, status, and other information are correct.</li>
<li>Compile the file locally and check the content for accuracy (including the correct date and version number).</li>
<li>Check the changes into source control.</li>
<li>Log into the webserver as the 'xsf' user, change directories to /home/xsf/xmpp-hg/extensions, run the "archive.sh" script to copy the previous XEP version to the "attic" (just in case the last editor team member forgot), type 'hg pull' and 'hg update', and run the "gen.py" script to generate HTML and PDF files.</li>
<li>
Log into the webserver as the 'xsf' user, change directories to
/home/xsf/xmpp-hg/extensions, run the "archive.sh" script to copy the
previous XEP version to the "attic" (just in case the last editor team
member forgot), type 'hg pull' and 'hg update'.
</li>
<li>
Run '/docker/xmpp.org_extensions/create.sh' as root, or, if you don't have
root, pester someone on the i-team.
</li>
<li>Wait.</li>
<li>Run the "announce.py" script on the webserver (see note about <link url='#lists'>List Administration</link>).</li>
</ol>
@ -187,7 +214,7 @@ $ . /usr/local/virtualenv/gen/bin/activate @@ -187,7 +214,7 @@ $ . /usr/local/virtualenv/gen/bin/activate
$ # or "export PATH=/usr/local/virtualenv/gen/bin:$PATH
$ ./archive.sh 0353 0.1
$ hg pull && hg update
$ ./gen.py xep-0353.xml
$ sudo /docker/xmpp.org_extensions/create.sh
$ ./announce.py 0353
]]></code>
</section2>

Loading…
Cancel
Save