Browse Source

Tweak XEP editor readme to mention Docker

Sam Whited 1 year ago
parent
commit
f2d595964a
1 changed files with 32 additions and 5 deletions
  1. 32
    5
      xep-README.xml

+ 32
- 5
xep-README.xml View File

@@ -115,8 +115,20 @@
115 115
 </header>
116 116
 
117 117
 <section1 topic='Overview' anchor='overview'>
118
-<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>
119
-<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>
118
+  <p>
119
+    The XMPP Extensions Editor (or, for short, XEP Editor) manages the XMPP
120
+    extensions process as defined in &xep0001;. In addition, the XEP Editor
121
+    functions as the XMPP Registrar as defined in &xep0053;. Read those
122
+    documents first, since this README focuses on mechanics instead of
123
+    philosophy or policy.
124
+  </p>
125
+  <p>
126
+    Since the inception of the &XSF; in 2001 until early 2014, the &EDITOR; was
127
+    Peter Saint-Andre. In early 2014, the &XSF; formed a "work team" to
128
+    dispatch the responsibilities of the XEP Editor and XMPP Registrar. This
129
+    document describes most of the details about how those responsibilities are
130
+    performed.
131
+  </p>
120 132
 </section1>
121 133
 
122 134
 <section1 topic='XEP Editor Responsibilities' anchor='ed'>
@@ -160,8 +172,13 @@
160 172
       <li>Set the status to Experimental.</li>
161 173
       <li>Check the file for egregious errors.</li>
162 174
       <li>Add a reference for the new XEP in the xep.ent file and check those changes into source control.</li>
163
-      <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>
175
+      <li>Log into the webserver, change directories to /home/xsf/xmpp-hg/extensions, type 'hg pull' and 'hg update'.</li>
164 176
       <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>
177
+      <li>
178
+        Run '/docker/xmpp.org_extensions/create.sh' as root, or, if you don't
179
+        have root, pester someone on the i-team.
180
+      </li>
181
+      <li>Wait.</li>
165 182
       <li>Run the "announce.py" script (see note about <link url='#lists'>List Administration</link>).</li>
166 183
       <li>Redirect the HTML file in the "inbox" to the new XEP URL (see existing examples on the webserver).</li>
167 184
     </ol>
@@ -175,7 +192,17 @@
175 192
   <li>Verify that the version number, status, and other information are correct.</li>
176 193
   <li>Compile the file locally and check the content for accuracy (including the correct date and version number).</li>
177 194
   <li>Check the changes into source control.</li>
178
-  <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>
195
+  <li>
196
+    Log into the webserver as the 'xsf' user, change directories to
197
+    /home/xsf/xmpp-hg/extensions, run the "archive.sh" script to copy the
198
+    previous XEP version to the "attic" (just in case the last editor team
199
+    member forgot), type 'hg pull' and 'hg update'.
200
+  </li>
201
+  <li>
202
+    Run '/docker/xmpp.org_extensions/create.sh' as root, or, if you don't have
203
+    root, pester someone on the i-team.
204
+  </li>
205
+  <li>Wait.</li>
179 206
   <li>Run the "announce.py" script on the webserver (see note about <link url='#lists'>List Administration</link>).</li>
180 207
 </ol>
181 208
 
@@ -187,7 +214,7 @@ $ . /usr/local/virtualenv/gen/bin/activate
187 214
 $ # or "export PATH=/usr/local/virtualenv/gen/bin:$PATH
188 215
 $ ./archive.sh 0353 0.1
189 216
 $ hg pull && hg update
190
-$ ./gen.py xep-0353.xml
217
+$ sudo /docker/xmpp.org_extensions/create.sh
191 218
 $ ./announce.py 0353
192 219
 ]]></code>
193 220
 </section2>

Loading…
Cancel
Save