From a8500f8aad52bc460d19de95669ba29748efc544 Mon Sep 17 00:00:00 2001 From: Cody Boone Ferguson <53008573+xexyl@users.noreply.github.com> Date: Mon, 17 Jun 2024 08:33:04 -0700 Subject: [PATCH] Fix two authors' info in 1995, update FAQ The (same two) authors of 1995/heathbar and 1995/makarios had invalid information, in one case email as well as in both the url and location. The location was previously set to unknown (ZZ) but I knew from the archive (which used to be what the README.md files which were the hint files had until I was asked to remove that information which was done November 2023) that it was US. I also noticed, however, that the url was invalid and in one case the email was invalid (it referred to the same domain). With these problems in mind the url was changed to refer to the website on the Internet Wayback Machine (in both), the email was set to null in the one that had an email (now it's null in both) and the location_code was set to US (in both). I then did: touch 1995/heathbar/README.md 1995/makarios/README.md so that I could do: make quick_www as only two index.html files had to be updated. This also updated authors.html and location.html, of course. The FAQ was updated with more information on how to update author information with the above two as an example and it now also says how to validate json for those who want to make changes to author information (or if anything else in the future is put in json). --- 1995/heathbar/index.html | 4 +- 1995/makarios/index.html | 4 +- author/Heather_Downs.json | 6 +- author/Selene_Makarios.json | 4 +- authors.html | 8 +- faq.html | 110 ++++++++++++++++++++++----- faq.md | 143 +++++++++++++++++++++++++++++++----- location.html | 8 +- 8 files changed, 230 insertions(+), 57 deletions(-) diff --git a/1995/heathbar/index.html b/1995/heathbar/index.html index 22f9fb46a..6930e8d1a 100644 --- a/1995/heathbar/index.html +++ b/1995/heathbar/index.html @@ -394,10 +394,10 @@ diff --git a/1995/makarios/index.html b/1995/makarios/index.html index 1e3042db0..b1aa67b7f 100644 --- a/1995/makarios/index.html +++ b/1995/makarios/index.html @@ -394,10 +394,10 @@ diff --git a/author/Heather_Downs.json b/author/Heather_Downs.json index 0513e4908..cb5bbb3cd 100644 --- a/author/Heather_Downs.json +++ b/author/Heather_Downs.json @@ -4,9 +4,9 @@ "author_handle" : "Heather_Downs", "full_name" : "Heather Downs", "sort_word" : "downs", - "location_code" : "ZZ", - "email" : "heather@bungalow.com", - "url" : "http://www.bungalow.com/", + "location_code" : "US", + "email" : null, + "url" : "https://web.archive.org/web/19961019045145/http://www.bungalow.com/", "alt_url" : null, "deprecated_twitter_handle" : null, "mastodon" : null, diff --git a/author/Selene_Makarios.json b/author/Selene_Makarios.json index d6e181981..b29e0576f 100644 --- a/author/Selene_Makarios.json +++ b/author/Selene_Makarios.json @@ -4,9 +4,9 @@ "author_handle" : "Selene_Makarios", "full_name" : "Selene Makarios", "sort_word" : "makarios", - "location_code" : "ZZ", + "location_code" : "US", "email" : null, - "url" : "http://www.bungalow.com/", + "url" : "https://web.archive.org/web/19961019045145/http://www.bungalow.com/", "alt_url" : null, "deprecated_twitter_handle" : null, "mastodon" : null, diff --git a/authors.html b/authors.html index 9569e0dd0..791c3c857 100644 --- a/authors.html +++ b/authors.html @@ -1380,9 +1380,9 @@ author_handle: ZZ - Unknown location +Location: US - United States of America (United States)
-URL: http://www.bungalow.com/ +URL: https://web.archive.org/web/19961019045145/http://www.bungalow.com/
author_handle: Heather_Downs

@@ -2583,9 +2583,9 @@ author_handle: ZZ - Unknown location +Location: US - United States of America (United States)
-URL: http://www.bungalow.com/ +URL: https://web.archive.org/web/19961019045145/http://www.bungalow.com/
author_handle: Selene_Makarios

diff --git a/faq.html b/faq.html index ce2ad77e2..ada675985 100644 --- a/faq.html +++ b/faq.html @@ -1199,13 +1199,15 @@ hints, especially in cases were something else needs to be installed.

If you have a fix that makes a minimal impact to the entry, then please consider submitting that change in the form of a pull request. Please see FAQ 5.2 How may I submit a fix to an IOCCC -entry. See also the FAQ 6.10 How does someone +entry. See also the FAQ 6.10 How does someone make a change to a file and submit that change as a GitHub pull request for more information about pull requests.

-

In some cases alternative code has been added that does compile on some or most systems. Check the write up for the entry for “alt” code and possible ways to compile and run that code. In some cases we replaced the original code (but not the .orig.c file!) with code -that works for modern systems but one can view the original code in the -.orig.c files (sometimes the original code is also in the directory as a -dirname.alt.c or prog.alt.c).

+

In some cases alternative code has been added that does compile on some or most +systems. Check the write up for the entry for “alt” code and possible ways to +compile and run that code. In some cases we replaced the original code (but not +the .orig.c file!) with code that works for modern systems but one can view +the original code in the .orig.c files (sometimes the original code is also in +the directory as a dirname.alt.c or prog.alt.c).

It might also be worth noting that almost all entries, have been fixed so that they can compile in modern systems though just because an entry compiles does not mean it will run on your specific system.

@@ -1234,7 +1236,7 @@ a pull request with that change. Pull requests that fix such code while trying to minimize the impact of any changes and preserving the spirit of the original code are very welcome! Please see FAQ 5.2 How may I submit a fix to an IOCCC entry for -details. See also the FAQ 6.10 How does someone make a change to +details. See also the FAQ 6.10 How does someone make a change to a file and submit that change as a GitHub pull request for more information about pull requests.

@@ -1269,7 +1271,7 @@ other things that have to be done plus remembering to do it.

that fixes the problem (even if it just a change to the Makefile) that doesn’t negatively impact the entry too much, consider submitting that change in the form of a pull request. Please see FAQ 5.2 How may I submit a fix to an IOCCC -entry. See also the FAQ 6.10 How does someone +entry. See also the FAQ 6.10 How does someone make a change to a file and submit that change as a GitHub pull request for more information about pull requests.

@@ -1474,8 +1476,8 @@ for downloading, installing and using SDL.

In the case that some entries do not work even with SDL1/SDL2 installed it might be that you need additional SDL libraries. See the entry’s index.html for details. If something is not noted you’re welcome to report it as an issue or -fix it and make a new pull request.

-

See the FAQ 6.10 How does someone make a change to a file and submit that change +fix it and make a pull request.

+

See the FAQ 6.10 How does someone make a change to a file and submit that change as a GitHub pull request for more information about pull requests.

@@ -2164,7 +2166,7 @@ fix. If it is accepted we’ll be happy to credit you in the link to your entries; if you’re not we can link to your website if you wish.

Please see FAQ 5.2 How may I submit a fix to an IOCCC entry for information on how to submit a fix to an -IOCCC entry. See also the FAQ 6.10 How does someone make a change +IOCCC entry. See also the FAQ 6.10 How does someone make a change to a file and submit that change as a GitHub pull request for more information about pull requests.

@@ -2185,7 +2187,7 @@ repo.

such as “index.html” files, fixing issues in a “Makefile”, or otherwise correcting an IOCCC entry is VERY MUCH WELCOME! Please use the same GitHub pull request process against -the master branch of the +the master branch of the ioccc-src/winner repo.

NOTE: some of the issues in the bugs.html file includes just missing files and we welcome these too!

@@ -2196,10 +2198,10 @@ IOCCC winning entries are presented!

And of course, an IOCCC author may update their own entries (metadata as well as source code and any extra files) by opening a GitHub pull request -against the master branch +against the master branch of the ioccc-src/winner repo.

Please see FAQ 5.2 How may I submit a fix to an IOCCC -entry. See also the FAQ 6.10 How does someone +entry. See also the FAQ 6.10 How does someone make a change to a file and submit that change as a GitHub pull request for more information about pull requests.

Note that we’re much more inclined to accept an author’s fixes but the judges @@ -2232,11 +2234,11 @@ to open a new IOCCC iss

For IOCCC website problems that relate to a particular IOCCC entry, please see FAQ 5.2 for information on how submit a fix to an IOCCC entry.

You may open a GitHub pull request -against the master branch +against the master branch of the ioccc-src/winner repo to submit a fix.

Please see FAQ 5.2 How may I submit a fix to an IOCCC -entry. See also the FAQ 6.10 How does someone +entry. See also the FAQ 6.10 How does someone make a change to a file and submit that change as a GitHub pull request for more information about pull requests.

Some HTML files should NOT be directly modified

@@ -2263,7 +2265,7 @@ request. There are quicker ways but to be sure you get everything built you should do this. If you modified a markdown and you do not see the same file as a html file then you did not complete the fix.

Please see FAQ 5.2 How may I submit a fix to an IOCCC -entry. See also the FAQ 6.10 How does someone +entry. See also the FAQ 6.10 How does someone make a change to a file and submit that change as a GitHub pull request for more information about pull requests.

In some cases, the HTML file is NOT based on markdown content, but instead @@ -2303,19 +2305,54 @@ about authors of IOCCC entries. See FAQ 6.6 for infor about the contents of these JSON file and how they are used.

You may update IOCCC author information in a author_handle.json file by submitting a pull request -against the master branch +against the master branch of the ioccc-src/winner repo.

-

Please see FAQ 5.2 How may I submit a fix to an IOCCC entry.

-

See also the FAQ 6.10 How does someone +

As these files are JSON you should verify that they are validly formed (e.g. you +didn’t make a typo).

+

Please make sure that you run make www after updating the file or files. This unfortunately +takes quite a while but it is the safest way to do it. There are other ways to go +about this that can speed things up. Here is one such way which was done when +fixing two authors in 1995 (in one commit as they were the authors of the same +two entries):

+

First, the two files, author/Heather_Downs.json and +author/Selene_Makarios.json were fixed (the +location was set as ZZ but Cody Boone Ferguson knew from the archive that it +was the US for both of them and he also noticed that the URL, the same for +both, was no longer valid and it was also known that the email was no longer +valid as it referred to the same domain). Thus the location_code, url (it was on the Internet Wayback Machine) and +in one case the email lines to look like:

+
    "location_code" : "US",
+    "email" : null,
+    "url" : "https://web.archive.org/web/19961019045145/http://www.bungalow.com/",
+

Now since only two entries (the same entries) were won by these two individuals +it means that only two index.html files had to be updated, besides the +authors.html and location.html files. These +are: 1995/heathbar/index.html and +1995/makarios/index.html. Thus the following +procedure was done:

+
        touch 1995/heathbar/README.md 1995/makarios/README.md
+        make quick_www
+

That works because the 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 tool would +only worry about those two files. This greatly speeds things along.

+

Once that command finishes a proper git status and git diff shows that +everything is in order. In the end the safest way is to run make www, however.

+

Please see FAQ 5.2 How may I submit a fix to an IOCCC entry?.

+

See also the FAQ 6.10 How does someone make a change to a file and submit that change as a GitHub pull request for more information about pull requests.

FYI: The ZZ - Unknown location is used for historic winning authors whose location or country is not known, whereas the XX - Anonymous location is used when the winning author does not wish to disclose their location.

+

Important note about XX - Anonymous location:

Unless you are the author who originally selected the XX - Anonymous location, please do not attempt to change an XX - Anonymous -location, without the permission of the original author.

+location without the permission of the original author, as sometimes they +want to have the location known but not their name and/or other details.