improve FAQ 5.5 and FAQ 6.16
We improve FAQ 5.5 (correcting or updating IOCCC author information) by adding a generic example on changing author's URL. Now the "PLEASE HELP us identify proper locations for IOCCC authors" (that now follows the change of URL example) contains only generic information about changing the location_code from ZZ to AU. We remove the indirect reference to author email in FAQ 6.16 as we do not wish to call out what we previously included in the `authors.html` page. This commit modifies that otherwise perfect fine PR #2578. Performed `make www` to accomplish the above and to test under macOS.
This commit is contained in:
1 parent
291084a0cf
commit
6d7b5348b6
2 files changed
+109
-49
No files matched your search
@@ -3189,15 +3189,14 @@ for information on opening up an IOCCC issue.</p>
|
|||||||
<h2 id="faq-5.5-how-may-i-correct-or-update-ioccc-author-information">FAQ 5.5: How may I correct or update IOCCC author information?</h2>
|
<h2 id="faq-5.5-how-may-i-correct-or-update-ioccc-author-information">FAQ 5.5: How may I correct or update IOCCC author information?</h2>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<h4 id="please-help-us-identify-proper-locations-for-ioccc-authors">PLEASE HELP us identify proper locations for IOCCC authors</h4>
|
<p>You may correct or update IOCCC author information by submitting a
|
||||||
<p>If you know the location of an author listed under:</p>
|
GitHub pull request that modifies an author’s <code>author_handle.json</code> file.</p>
|
||||||
<p> <strong><a href="location.html#ZZ">ZZ - Unknown location</a></strong></p>
|
<p>For example, if a given <code>author_handle.json</code> file contained:</p>
|
||||||
<p>or if you find IOCCC author location that is incorrect,
|
<pre><code> "url" : "https://www.example.com/employee/username",</code></pre>
|
||||||
then <strong>please submit a pull request</strong>,
|
<p>and you knew that the author has long ago left the <code>www.example.com</code> company,
|
||||||
or at least <a href="contact.html">inform the IOCCC judges</a>.</p>
|
and that they have a new faculty web page at <code>www.example.edu</code>, then you should
|
||||||
<p>See the
|
submit a GitHub pull request to change the above line to:</p>
|
||||||
FAQ on “<a href="#pull_request">GitHub pull request</a>”
|
<pre><code> "url" : "https://www.example.edu/faculty/department/user.name",</code></pre>
|
||||||
for more information.</p>
|
|
||||||
<p>Authors of IOCCC winning entries are kept in JSON files of the form:</p>
|
<p>Authors of IOCCC winning entries are kept in JSON files of the form:</p>
|
||||||
<pre><code> author/author_handle.json</code></pre>
|
<pre><code> author/author_handle.json</code></pre>
|
||||||
<p>where <code>author_handle</code> is an author handle.</p>
|
<p>where <code>author_handle</code> is an author handle.</p>
|
||||||
@@ -3206,35 +3205,57 @@ FAQ on “<a href="#author_handle_faq">author handle</a>”
|
|||||||
for more information about author handles.</p>
|
for more information about author handles.</p>
|
||||||
<p>See the
|
<p>See the
|
||||||
FAQ on “<a href="#author_json">author_handle.json</a>”
|
FAQ on “<a href="#author_json">author_handle.json</a>”
|
||||||
for information about the contents of these JSON file and how they are used.</p>
|
for information about the contents of these JSON files and how they are used.</p>
|
||||||
<p>See the
|
<p>See the
|
||||||
FAQ on “<a href="#find_author_handle">finding author handles</a>”
|
FAQ on “<a href="#find_author_handle">finding author handles</a>”
|
||||||
for how to find your own <em>author_handle</em>.</p>
|
for how to find an <em>author_handle</em>.</p>
|
||||||
<p>The contents of these JSON files contain the best known information
|
|
||||||
about authors of IOCCC entries. See
|
|
||||||
FAQ on “<a href="#author_json">author_handle.json</a>”
|
|
||||||
for information about the contents of these JSON file and how they are used.</p>
|
|
||||||
<p>You may update IOCCC author information in a <code>author_handle.json</code> file
|
<p>You may update IOCCC author information in a <code>author_handle.json</code> file
|
||||||
by <a href="#pull_request">submitting a pull request</a>
|
by <a href="#pull_request">submitting a pull request</a>
|
||||||
against the <a href="https://github.com/ioccc-src/winner/branches">master branch</a>
|
against the <a href="https://github.com/ioccc-src/winner/branches">master branch</a>
|
||||||
of the <a href="https://github.com/ioccc-src/winner">ioccc-src/winner repo</a>.</p>
|
of the <a href="https://github.com/ioccc-src/winner">ioccc-src/winner repo</a>.</p>
|
||||||
<p>As these files are JSON you should verify that they are validly formed (e.g. you
|
<p>See the
|
||||||
didn’t make a typo).</p>
|
FAQ on “<a href="#pull_request">GitHub pull request</a>”
|
||||||
<p>Please make sure that you run <code>make www</code> after updating the file or files. This unfortunately
|
for more information.</p>
|
||||||
takes quite a while but it is the safest way to do it. And while <code>make quick_www</code>
|
<p><strong>IMPORTANT NOTE</strong>: As these files are JSON you should verify that
|
||||||
can greatly speed up your testing, we still recommend running a final <code>make www</code> just before
|
they are validly formed (e.g., you didn’t make a typo).</p>
|
||||||
you form your pull request.</p>
|
<p>Before you form your GitHub pull request that modifies a
|
||||||
<p>Once that command finishes a proper <code>git status</code> and <code>git diff</code> shows that
|
<code>author_handle.json</code> file, please run the <code>make www</code> command. This
|
||||||
everything is in order. In the end the safest way is to run <code>make www</code>, however.</p>
|
unfortunately takes quite a while but it is the safest way to do
|
||||||
|
it. So you may wish to test your edits by running the somewhat
|
||||||
|
quicker <code>make quick_www</code> as this can speed up your testing.</p>
|
||||||
|
<p>The <code>make quick_www</code> rule will update the <code>authors.html</code> and
|
||||||
|
<code>location.html</code> pages and it will also check the timestamps of the <code>index.html</code>
|
||||||
|
files versus the <code>README.md</code> files. Since they were touched and thus the
|
||||||
|
timestamp was updated, the
|
||||||
|
<a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/bin/quick-readme2index.sh">bin/quick-readme2index.sh</a> tool would
|
||||||
|
only worry about those two files. This greatly speeds things along while testing.
|
||||||
|
Nevertheless, doing a final <code>make www</code> is still recommended best practice
|
||||||
|
before you form your pull request.</p>
|
||||||
<p>Please see
|
<p>Please see
|
||||||
FAQ on “<a href="#fix_an_entry">fixing an entry</a>”.</p>
|
FAQ on “<a href="#fix_an_entry">fixing an entry</a>”.</p>
|
||||||
<p>See also the
|
<p>See also the
|
||||||
FAQ on “<a href="#pull_request">GitHub pull request</a>”
|
FAQ on “<a href="#pull_request">GitHub pull request</a>”
|
||||||
for more information about pull requests.</p>
|
for more information about pull requests.</p>
|
||||||
|
<h4 id="please-help-us-identify-proper-locations-for-ioccc-authors">PLEASE HELP us identify proper locations for IOCCC authors</h4>
|
||||||
|
<p>If you know the location of an author listed under:</p>
|
||||||
|
<p> <strong><a href="location.html#ZZ">ZZ - Unknown location</a></strong></p>
|
||||||
|
<p>or if you find IOCCC author location that is incorrect,
|
||||||
|
then <strong>please submit a pull request</strong>,
|
||||||
|
or at least <a href="contact.html">inform the IOCCC judges</a>.</p>
|
||||||
<p><strong>FYI</strong>: The <a href="location.html#ZZ">ZZ - Unknown location</a> is used for
|
<p><strong>FYI</strong>: The <a href="location.html#ZZ">ZZ - Unknown location</a> is used for
|
||||||
historic winning authors whose location or country is not known,
|
historic winning authors whose location or country is not known,
|
||||||
whereas the <a href="location.html#XX">XX - Anonymous location</a> is used when the
|
whereas the <a href="location.html#XX">XX - Anonymous location</a> is used when the
|
||||||
winning author does <strong>not wish to disclose their location</strong>.</p>
|
winning author does <strong>not wish to disclose their location</strong>.</p>
|
||||||
|
<p>The contents of these JSON files contain the best known information
|
||||||
|
about authors of IOCCC entries. See
|
||||||
|
FAQ on “<a href="#author_json">author_handle.json</a>”
|
||||||
|
for information about the contents of these JSON files and how they are used.</p>
|
||||||
|
<p>For example, if a given <code>author_handle.json</code> file contained:</p>
|
||||||
|
<pre><code> "location_code" : "ZZ",</code></pre>
|
||||||
|
<p>and you knew that the author was located in <a href="location.html#AU">Australia</a>
|
||||||
|
(location code <strong>AU</strong>), we encourage you to submit a <strong>GitHub pull
|
||||||
|
request</strong> to change that line to:</p>
|
||||||
|
<pre><code> "location_code" : "AU",</code></pre>
|
||||||
<h3 id="important-note-about-xx---anonymous-location">Important note about <strong>XX - Anonymous location</strong>:</h3>
|
<h3 id="important-note-about-xx---anonymous-location">Important note about <strong>XX - Anonymous location</strong>:</h3>
|
||||||
<p>Unless you are the author who originally selected the <strong>XX - Anonymous
|
<p>Unless you are the author who originally selected the <strong>XX - Anonymous
|
||||||
location</strong>, please do not attempt to change an <strong>XX - Anonymous
|
location</strong>, please do not attempt to change an <strong>XX - Anonymous
|
||||||
@@ -3460,7 +3481,7 @@ for information about how to update
|
|||||||
and/or correct IOCCC author information.</p>
|
and/or correct IOCCC author information.</p>
|
||||||
<p>See the
|
<p>See the
|
||||||
FAQ on “<a href="#auth_json">.auth.json</a>”
|
FAQ on “<a href="#auth_json">.auth.json</a>”
|
||||||
for information about the contents of these JSON file and
|
for information about the contents of these JSON files and
|
||||||
how they are used.</p>
|
how they are used.</p>
|
||||||
<p>See the
|
<p>See the
|
||||||
FAQ on “<a href="#find_author_handle">finding author handle</a>”
|
FAQ on “<a href="#find_author_handle">finding author handle</a>”
|
||||||
|
|||||||
@@ -3708,19 +3708,22 @@ for information on opening up an IOCCC issue.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
#### PLEASE HELP us identify proper locations for IOCCC authors
|
You may correct or update IOCCC author information by submitting a
|
||||||
|
GitHub pull request that modifies an author's `author_handle.json` file.
|
||||||
|
|
||||||
If you know the location of an author listed under:
|
For example, if a given `author_handle.json` file contained:
|
||||||
|
|
||||||
**[ZZ - Unknown location](location.html#ZZ)**
|
``` <!---json-->
|
||||||
|
"url" : "https://www.example.com/employee/username",
|
||||||
|
```
|
||||||
|
|
||||||
or if you find IOCCC author location that is incorrect,
|
and you knew that the author has long ago left the `www.example.com` company,
|
||||||
then **please submit a pull request**,
|
and that they have a new faculty web page at `www.example.edu`, then you should
|
||||||
or at least [inform the IOCCC judges](contact.html).
|
submit a GitHub pull request to change the above line to:
|
||||||
|
|
||||||
See the
|
``` <!---json-->
|
||||||
FAQ on "[GitHub pull request](#pull_request)"
|
"url" : "https://www.example.edu/faculty/department/user.name",
|
||||||
for more information.
|
```
|
||||||
|
|
||||||
Authors of IOCCC winning entries are kept in JSON files of the form:
|
Authors of IOCCC winning entries are kept in JSON files of the form:
|
||||||
|
|
||||||
@@ -3736,32 +3739,38 @@ for more information about author handles.
|
|||||||
|
|
||||||
See the
|
See the
|
||||||
FAQ on "[author_handle.json](#author_json)"
|
FAQ on "[author_handle.json](#author_json)"
|
||||||
for information about the contents of these JSON file and how they are used.
|
for information about the contents of these JSON files and how they are used.
|
||||||
|
|
||||||
See the
|
See the
|
||||||
FAQ on "[finding author handles](#find_author_handle)"
|
FAQ on "[finding author handles](#find_author_handle)"
|
||||||
for how to find your own _author_handle_.
|
for how to find an _author_handle_.
|
||||||
|
|
||||||
The contents of these JSON files contain the best known information
|
|
||||||
about authors of IOCCC entries. See
|
|
||||||
FAQ on "[author_handle.json](#author_json)"
|
|
||||||
for information about the contents of these JSON file and how they are used.
|
|
||||||
|
|
||||||
You may update IOCCC author information in a `author_handle.json` file
|
You may update IOCCC author information in a `author_handle.json` file
|
||||||
by [submitting a pull request](#pull_request)
|
by [submitting a pull request](#pull_request)
|
||||||
against the [master branch](https://github.com/ioccc-src/winner/branches)
|
against the [master branch](https://github.com/ioccc-src/winner/branches)
|
||||||
of the [ioccc-src/winner repo](https://github.com/ioccc-src/winner).
|
of the [ioccc-src/winner repo](https://github.com/ioccc-src/winner).
|
||||||
|
|
||||||
As these files are JSON you should verify that they are validly formed (e.g. you
|
See the
|
||||||
didn't make a typo).
|
FAQ on "[GitHub pull request](#pull_request)"
|
||||||
|
for more information.
|
||||||
|
|
||||||
Please make sure that you run `make www` after updating the file or files. This unfortunately
|
**IMPORTANT NOTE**: As these files are JSON you should verify that
|
||||||
takes quite a while but it is the safest way to do it. And while `make quick_www`
|
they are validly formed (e.g., you didn't make a typo).
|
||||||
can greatly speed up your testing, we still recommend running a final `make www` just before
|
|
||||||
you form your pull request.
|
|
||||||
|
|
||||||
Once that command finishes a proper `git status` and `git diff` shows that
|
Before you form your GitHub pull request that modifies a
|
||||||
everything is in order. In the end the safest way is to run `make www`, however.
|
`author_handle.json` file, please run the `make www` command. This
|
||||||
|
unfortunately takes quite a while but it is the safest way to do
|
||||||
|
it. So you may wish to test your edits by running the somewhat
|
||||||
|
quicker `make quick_www` as this can speed up your testing.
|
||||||
|
|
||||||
|
The `make quick_www` rule will update the `authors.html` and
|
||||||
|
`location.html` pages and it will also check the timestamps of the `index.html`
|
||||||
|
files versus the `README.md` files. Since they were touched and thus the
|
||||||
|
timestamp was updated, the
|
||||||
|
[bin/quick-readme2index.sh](%%REPO_URL%%/bin/quick-readme2index.sh) tool would
|
||||||
|
only worry about those two files. This greatly speeds things along while testing.
|
||||||
|
Nevertheless, doing a final `make www` is still recommended best practice
|
||||||
|
before you form your pull request.
|
||||||
|
|
||||||
Please see
|
Please see
|
||||||
FAQ on "[fixing an entry](#fix_an_entry)".
|
FAQ on "[fixing an entry](#fix_an_entry)".
|
||||||
@@ -3770,11 +3779,40 @@ See also the
|
|||||||
FAQ on "[GitHub pull request](#pull_request)"
|
FAQ on "[GitHub pull request](#pull_request)"
|
||||||
for more information about pull requests.
|
for more information about pull requests.
|
||||||
|
|
||||||
|
#### PLEASE HELP us identify proper locations for IOCCC authors
|
||||||
|
|
||||||
|
If you know the location of an author listed under:
|
||||||
|
|
||||||
|
**[ZZ - Unknown location](location.html#ZZ)**
|
||||||
|
|
||||||
|
or if you find IOCCC author location that is incorrect,
|
||||||
|
then **please submit a pull request**,
|
||||||
|
or at least [inform the IOCCC judges](contact.html).
|
||||||
|
|
||||||
**FYI**: The [ZZ - Unknown location](location.html#ZZ) is used for
|
**FYI**: The [ZZ - Unknown location](location.html#ZZ) is used for
|
||||||
historic winning authors whose location or country is not known,
|
historic winning authors whose location or country is not known,
|
||||||
whereas the [XX - Anonymous location](location.html#XX) is used when the
|
whereas the [XX - Anonymous location](location.html#XX) is used when the
|
||||||
winning author does **not wish to disclose their location**.
|
winning author does **not wish to disclose their location**.
|
||||||
|
|
||||||
|
The contents of these JSON files contain the best known information
|
||||||
|
about authors of IOCCC entries. See
|
||||||
|
FAQ on "[author_handle.json](#author_json)"
|
||||||
|
for information about the contents of these JSON files and how they are used.
|
||||||
|
|
||||||
|
For example, if a given `author_handle.json` file contained:
|
||||||
|
|
||||||
|
``` <!---json-->
|
||||||
|
"location_code" : "ZZ",
|
||||||
|
```
|
||||||
|
|
||||||
|
and you knew that the author was located in [Australia](location.html#AU)
|
||||||
|
(location code **AU**), we encourage you to submit a **GitHub pull
|
||||||
|
request** to change that line to:
|
||||||
|
|
||||||
|
``` <!---json-->
|
||||||
|
"location_code" : "AU",
|
||||||
|
```
|
||||||
|
|
||||||
### Important note about **XX - Anonymous location**:
|
### Important note about **XX - Anonymous location**:
|
||||||
|
|
||||||
Unless you are the author who originally selected the **XX - Anonymous
|
Unless you are the author who originally selected the **XX - Anonymous
|
||||||
@@ -4074,7 +4112,7 @@ and/or correct IOCCC author information.
|
|||||||
|
|
||||||
See the
|
See the
|
||||||
FAQ on "[.auth.json](#auth_json)"
|
FAQ on "[.auth.json](#auth_json)"
|
||||||
for information about the contents of these JSON file and
|
for information about the contents of these JSON files and
|
||||||
how they are used.
|
how they are used.
|
||||||
|
|
||||||
See the
|
See the
|
||||||
@@ -5322,6 +5360,7 @@ Of course if you know the author's name you can go directly to
|
|||||||
[authors.html](authors.html) and click on their surname's/last name's/second
|
[authors.html](authors.html) and click on their surname's/last name's/second
|
||||||
name's initial and then scroll down (if necessary) to the author in question.
|
name's initial and then scroll down (if necessary) to the author in question.
|
||||||
|
|
||||||
|
|
||||||
<hr style="width:10%;text-align:left;margin-left:0">
|
<hr style="width:10%;text-align:left;margin-left:0">
|
||||||
|
|
||||||
Jump to: [top](#)
|
Jump to: [top](#)
|
||||||
|
|||||||
Reference in new issue
Block a user