Merge pull request #2767 from xexyl/submit-faq

faq.html

@@ -651,48 +651,85 @@ your entry and then re-run the <code>mkiocccentry</code> tool.</p>
 for doing so in your <code>remarks.md</code> file.</p>
 <p>See also <a href="next/rules.html#rule17">Rule 17</a>!</p>
 <h4 id="upload-your-entry-to-the-ioccc-submit-server">5. Upload your entry to the IOCCC submit server</h4>
-<p>The following steps should be taken:</p>
+<p>The following steps should be taken, in order to upload your <code>mkiocccentry</code> xz
-<p>First, open the web page in your browser. It should look something like this:</p>
+compressed tarball, to change the file (if you need to upload a different file
+or you have updated the submission), and to check the status of it after the
+contest closes:</p>
+<p>First, open the web page in your browser. It should look like this:
+With the login id and password already input, It should look something like
+this:</p>
 <p><img src="png/submit-server-login.png"
  alt="submit server login screen"
- width=566 height=609></p>
+ width=710 height=562></p>
-<p>At this point, using the UUID login and the password you were provided with step
+<p>The login is the UUID you were provided when you registered for the IOCCC and
-0, log in. Assuming everything is fine, you should see something like:</p>
+the password is the initial password you were provided with. Click “Login”.
-<p><img src="png/submit-server-passwd.png"
+Assuming everything is fine, it should look something like:</p>
+<p><img src="png/submit-server-first-login.png"
  alt="submit server password change required"
- width=566 height=854></p>
+ width=710 height=808></p>
-<p>At this point you should change your password. Once this is done, you will have
+<p>As you can see, you have to change your password. Put in your login (UUID
-to log in again:</p>
+username), your old (initial) password and a new password. For instance:</p>
+<p><img src="png/submit-server-change-passwd.png"
+ alt="submit server changing password"
+ width=710 height=808></p>
+<p>Click “Change Password”.</p>
+<p>Once this is done, you will have to log in again. Using the UUID login and the
+new password:</p>
 <p><img src="png/submit-server-passwd-changed.png"
  alt="submit server password changed"
- width=566 height=854></p>
+ width=710 height=344></p>
-<p>At this point, enter your UUID login and new password, and then click “Login”.
+<p>.. click “Login”.</p>
-You will see submit slots. Each slot is for one submission so if you update a
+<p>Once you’ve logged in, you will see submit slots. Each slot is for one
-submission, make sure you choose the right one so you do not overwrite the wrong
+submission so if you update a submission, make sure you choose the right one so
-one. In this next screenshot you will see slot 0 is already
+you do not overwrite the wrong one!</p>
-selected:</p>
+<p>Here is what it looks like without any uploads and no slot selected:</p>
 <p><img src="png/submit-server-slots.png"
- alt="submit server upload screen"
+ alt="submit server slots"
- width=566 height=905></p>
+ width=710 height=806></p>
-<p>Further down the page you should see something like:</p>
+<p>Select a slot and then select a file by clicking the button “Choose File”. After
-<p><img src="png/submit-server-file-select.png"
+doing this, it should look something like:</p>
- alt="submit server file select"
+<p><img src="png/submit-server-slot-file.png"
- width=566 height=312></p>
+ alt="submit server slot and file selected"
-<p>Click the link to upload your <code>mkiocccentry</code> compressed tarball. For instance:</p>
+ width=717 height=865></p>
-<p><img src="png/submit-server-file-selected.png"
+<p>If you need to change the file to upload, you can mouseover the file and click
- alt="submit server file selected"
+it. If you wait a moment it’ll show the current filename. It will look something
- width=566 height=300></p>
+like this:</p>
-<p>Click “Submit”. Once it’s uploaded, you should be presented with a new screen.
+<p><img src="png/submit-server-change-file.png"
-If you chose slot 0 you might see something like:</p>
+ alt="submit server change file"
+ width=717 height=865></p>
+<p>Once you’re certain you have selected the correct file, click “Submit”, below
+the file selection step.</p>
+<p>When it’s uploaded it should look something like this:</p>
 <p><img src="png/submit-server-submission-uploaded.png"
- alt="submit server file uploaded"
+ alt="submit server submission uploaded"
- width=566 height=574></p>
+ width=717 height=525></p>
-<p>After the submission deadline is reached, and after the judges have verified
+<p>Here you see the details, in particular:</p>
-that your submission is valid (as in passes the tools checks), you should see
+<ul>
-something like this:</p>
+<li>the status of the submission</li>
+<li>the filename, which will be in the correct format, assuming you used
+<code>mkiocccentry(1)</code> which is <strong>HIGHLY</strong> recommended so that you do not break <a href="next/rules.html#rule17">Rule
+17</a>!</li>
+<li>the file length, which <code>txzchk(1)</code> will also verify (the file itself and the
+tarball listing)</li>
+<li>the upload date</li>
+<li>the SHA256 hash of the file</li>
+</ul>
+<p>Now if you’re done, log out.</p>
+<p>After the submission deadline is reached, you can log in to check the status of
+your submissions. Here is what it will look like when the judges have verified
+that your tarball / submission has been validated (NOT judged), by <code>txzchk(1)</code>
+and <code>chkentry(1)</code>.:</p>
 <p><img src="png/submit-server-status-updated.png"
- alt="submit server file uploaded"
+ alt="submit server status updated"
- width=696 height=179></p>
+ width=717 height=217></p>
+<p>For details on <code>txzchk</code>, see the
+FAQ on “<a href="#txzchk">txzchk</a>”.</p>
+<p>For details on <code>chkentry</code>, see the
+FAQ on “<a href="#chkentry">chkentry</a>”.</p>
+<p>If you need more information on what <code>chkentry</code> checks, see the
+FAQ on the <a href="#info_json">“.info.json file</a>”
+and the
+FAQ on the “<a href="#auth_json">.auth.json file</a>”.</p>
 <p>Jump to: <a href="#">top</a></p>
 <div id="what_mkiocccentry">
 <div id="mkiocccentry">

faq.md

@@ -271,65 +271,112 @@ See also [Rule 17](next/rules.html#rule17)!
 
 #### 5. Upload your entry to the IOCCC submit server
 
-The following steps should be taken:
+The following steps should be taken, in order to upload your `mkiocccentry` xz
+compressed tarball, to change the file (if you need to upload a different file
+or you have updated the submission), and to check the status of it after the
+contest closes:
 
-First, open the web page in your browser. It should look something like this:
+First, open the web page in your browser. It should look like this:
+With the login id and password already input, It should look something like
+this:
 
 <img src="png/submit-server-login.png"
  alt="submit server login screen"
- width=566 height=609>
+ width=710 height=562>
 
-At this point, using the UUID login and the password you were provided with step
+The login is the UUID you were provided when you registered for the IOCCC and
-0, log in. Assuming everything is fine, you should see something like:
+the password is the initial password you were provided with. Click "Login".
+Assuming everything is fine, it should look something like:
 
-<img src="png/submit-server-passwd.png"
+<img src="png/submit-server-first-login.png"
  alt="submit server password change required"
- width=566 height=854>
+ width=710 height=808>
 
-At this point you should change your password. Once this is done, you will have
+As you can see, you have to change your password. Put in your login (UUID
-to log in again:
+username), your old (initial) password and a new password. For instance:
+
+<img src="png/submit-server-change-passwd.png"
+ alt="submit server changing password"
+ width=710 height=808>
+
+Click "Change Password".
+
+Once this is done, you will have to log in again. Using the UUID login and the
+new password:
 
 <img src="png/submit-server-passwd-changed.png"
  alt="submit server password changed"
- width=566 height=854>
+ width=710 height=344>
 
-At this point, enter your UUID login and new password, and then click "Login".
+
-You will see submit slots. Each slot is for one submission so if you update a
+.. click "Login".
-submission, make sure you choose the right one so you do not overwrite the wrong
+
-one. In this next screenshot you will see slot 0 is already
+Once you've logged in, you will see submit slots. Each slot is for one
-selected:
+submission so if you update a submission, make sure you choose the right one so
+you do not overwrite the wrong one!
+
+Here is what it looks like without any uploads and no slot selected:
 
 <img src="png/submit-server-slots.png"
- alt="submit server upload screen"
+ alt="submit server slots"
- width=566 height=905>
+ width=710 height=806>
 
-Further down the page you should see something like:
+Select a slot and then select a file by clicking the button "Choose File". After
+doing this, it should look something like:
 
+<img src="png/submit-server-slot-file.png"
+ alt="submit server slot and file selected"
+ width=717 height=865>
 
-<img src="png/submit-server-file-select.png"
+If you need to change the file to upload, you can mouseover the file and click
- alt="submit server file select"
+it. If you wait a moment it'll show the current filename. It will look something
- width=566 height=312>
+like this:
 
-Click the link to upload your `mkiocccentry` compressed tarball. For instance:
+<img src="png/submit-server-change-file.png"
+ alt="submit server change file"
+ width=717 height=865>
 
-<img src="png/submit-server-file-selected.png"
+Once you're certain you have selected the correct file, click "Submit", below
- alt="submit server file selected"
+the file selection step.
- width=566 height=300>
 
-Click "Submit". Once it's uploaded, you should be presented with a new screen.
+When it's uploaded it should look something like this:
-If you chose slot 0 you might see something like:
 
 <img src="png/submit-server-submission-uploaded.png"
- alt="submit server file uploaded"
+ alt="submit server submission uploaded"
- width=566 height=574>
+ width=717 height=525>
 
-After the submission deadline is reached, and after the judges have verified
+Here you see the details, in particular:
-that your submission is valid (as in passes the tools checks), you should see
+
-something like this:
+- the status of the submission
+- the filename, which will be in the correct format, assuming you used
+`mkiocccentry(1)` which is **HIGHLY** recommended so that you do not break [Rule
+17](next/rules.html#rule17)!
+- the file length, which `txzchk(1)` will also verify (the file itself and the
+tarball listing)
+- the upload date
+- the SHA256 hash of the file
+
+Now if you're done, log out.
+
+After the submission deadline is reached, you can log in to check the status of
+your submissions. Here is what it will look like when the judges have verified
+that your tarball / submission has been validated (NOT judged), by `txzchk(1)`
+and `chkentry(1)`.:
 
 <img src="png/submit-server-status-updated.png"
- alt="submit server file uploaded"
+ alt="submit server status updated"
- width=696 height=179>
+ width=717 height=217>
+
+For details on `txzchk`, see the
+FAQ on "[txzchk](#txzchk)".
+
+For details on `chkentry`, see the
+FAQ on "[chkentry](#chkentry)".
+
+If you need more information on what `chkentry` checks, see the
+FAQ on the [".info.json file](#info_json)"
+and the
+FAQ on the "[.auth.json file](#auth_json)".
 
 Jump to: [top](#)