A choice was made a while back to use website and not web site so
changed all new references of 'web site' to 'website':
sgit -e 's/web site/website/g' '*.md' '*.html'
As this also occurs in the FAQ and there were some minor mods (just
textual, including some fun, not a new FAQ) these are included too.
In order simplify the write-up of the actual Rule 17
into a new FAQ 1.8. The somewhat shorted Rule 17 text
now refers to checks performed by tools, encourages
their use, discourages their misuse (overriding limits),
and is easier to read: we think.
This addresses most (if not all) of the recent changes to chkentry(1)
though a more thorough check will be made later after the mkiocccentry
code freeze.
I have thought of and plugged additional holes in the process (same with
txzchk but that's beyond the scope of the document) so the FAQ was
updated for this.
Also because it is a long list of steps there is now a TL;DR part above
it.
There was an order issue in the list as well.
The FAQ stated (due to a mistake in the issue in the mkiocccentry repo)
that the submission directory (under workdir) has the timestamp in it
but that is not true. Instead the tarball filename has the timestamp.
Typo fix in guidelines.
The list now details every step taken and the question was also changed
to help make it easier to find (one need not read this but if they want
to it is now in the correct order).
It is highly recommended that you run the tool from either the repo
directory itself (making sure you have the most up to date version of
course) or make sure you have installed it (also making sure you have
the most recent version). Not doing this will cause issues with checks
and in the case of out of date versions the submission would be rejected
due to violating rule 17. One can specify the options to mkiocccentry
for the tools required but if you forget or don't have the most up to
date version you will very likely run into problems.
Rule 17 mandates specific file permissions for files/directories in
submission tarballs but the documentation did not state this. More work
might need to be done here but it should be better now.
The next/remarks.example.md filename is kind of a misnomer but it was
named this way to match Makefile.example. It has brief instructions
along with a link to the FAQ about what one should put in their
remarks.md file (and the FAQ links to the new file as a starting point
as it has instructions).
The markdown guidelines were updated to note that if one does use
sections in remarks.md file they should start out at heading level 3
(###) and for each subsection increment it by one (up to level 6).
The new syntax (though not all functionality is yet finished) of
mkiocccentry does not match what was in the FAQ, guidelines and rules.
Also added an important reminder to use v7 format with tarballs as not
doing so can reveal who you are which would break the rules. This is
mentioned in the rules and guidelines, showing how to create such a
tarball.
More work does have to be done with these two things however.
The `chkentry(1)` tool was changed so that the `.auth.json`
arg comes before the `.info.json` arg. These changes are
needed to accommodate and document that change.
Also the use of the single arg as a directory was
removed from documentation (until issue #940 is addressed).
The FAQ, guidelines and rules have been updated to reflect recent
discussions and modifications to the maximum number of files.
A new FAQ entry has been added. The guidelines talk about including
extra tarballs and rule 17 has been updated as well. Some of this was
copied directly from discussion with Landon.
Some minor other fixes were made in the guidelines and rules (mostly
wording).
Updated `faq.md` and `README.md` to point at the BSD source for the
old Bourne shell. Mentioned the GENIX operating system for the NS
SYS16 system. Added a note that the links are only approximations
of the BSD code that inspired the IOCCC.
Hello @tanaydin,
We are about to modify the result of your PR #54, @tanaydin to include
a link to the finger daemon source. Unfortunately the finger daemon
source is not found in that 4.2BSD repo, so we had to dip into the
[4.3BSD-Reno](https://github.com/dank101/4.3BSD-Reno) repo, which isn't
exactly correct as that post-dates the 1984 IOCCC starting event but
will have to do.
We modified the link to use HTML "Left Parenthesis" and "Right Parenthesi"
as per [IOCCC markdown guidelines regarding LITERAL “(” or “)” in
markdown link titles](https://www.ioccc.org/markdown.html#parentheses)
in order to your mod to pass the web site test code.
We also modified the references in the FAQ, as per your suggestion.
We also performed needed changes to update the associated HTML files.
We thank you for recommending this change.
Stay tuned for the update.
We set dates and times for when IOCCC28 will go into pending state,
open state, and judging state. These dates are subject to change until
the content enters the open state.
Modified both `next/guidelines.md` and `next/rules.md` as per the
IOCCC28 dates and times.
Improve the `next/guidelines.md` and `next/rules.md` text around IOCCC28 dates and times.
We processed the XXX's in markdown files that needed processing.
Fixed a minor typo in `bin/cvt-submission.sh`.
Made some minor formatting improvements to `faq.md`, `next/register.md`,
`next/rules.md`, `next/guidelines.md`, `README.md` and `index.md`.
Updated "Rule 3" in `next/rules.md` in regards to the above.
Updated "Rule 8" in `next/rules.md` in regards to the above.
Changed `faq.md` version from **28.1.8 2024-12-07**
to **28.2.0 2024-12-28**.
Changed `next/guidelines.md` version from **28.29 2024-12-27**
to **28.30 2024-12-28**.
Changed `next/rules.md` version from **28.14 2024-12-07**
to **28.15 2024-12-28**.
TODO: Review these changes.
The menu in all html pages for the FAQ was fixed to link to the step 0
(of how to enter the contest) and also it was renamed ('Enter the
IOCCC').
I also went through the most important sections of the FAQ (how to
enter and the mkiocccentry related questions) and checked the
register.html, pw-change.html and submit.html pages. It is possible I
have missed something but I think it's in pretty good shape nonetheless.
Some broken links were fixed in some of the files like next/index.html,
next/pw-change.html, next/index.html and status.html.
Some wrong images were used in next/submit.html (or at least referred to
wrong if not wrong image).
Useful update to FAQ about the answers file in mkiocccentry.
There might have been other things.
This might be all that is needed for next/ wrt the register/change
password/submit but it's possible something has slipped through.
We added some images to `next/register.md` and thus to
`next/register.html`.
We modified FAQ 0.0 with these 2 new steps:
3. Wait for your submit server username and initial password
4. Login to the submit server and change your password
This is just a checkpoint: these need to be improved but
we are too tired.
NEEDED TODO: Create a new `next/chpw.html` page and move the images
and text from the new FAQ 0.0 step 4 into this new place.
This will keep the step of FAQ 0.0 shorter to read while
keeping the details and images in a separate web page.
We added lettered steps to `next/register.md` as part of our
configuring the mailing list for IOCCC28.
Change "IOCCC Judges" to the more commonly used "IOCCC judges"
and made it a HTML link in `2014/README.md`, `2015/README.md`,
and `faq.md`.
Added a reference to "first time login" in `next/submit.md`.
Improved some text in Step 3 of FAQ 0.0 of `faq.md`.
Performed `make quick_www` to update the HTML pages.
TODO: Need to add images to the lettered steps in `next/register.md.
Added a new `next/submit.html` to move the "how to submit" form "in-line"
of the top FAQ entry into a new page managed by `next/submit.md`.
Thus, `next/submit.html` is a parallel to `next/register.html`
and `next/submit.md` is a parallel to `next/register.md`.
Changed the FAQ "faq.html#submit" and into "faq.html#enter".
Added individual tags for the steps in FAQ0.0.
Moved "faq.html#register" down to FAQ 0.0 step 2.
Added "faq.html#submit" for FAQ 0.0 step 5,
however elsewhere often "next/submit.html" is used.
Changed references for "faq.html#upload" to "next/submit.html".
We made a number of changes to the following markdown files to reflect the above:
- `about.md`
- `faq.md`
- `index.md`
- `markdown.md`
- `next/README.md`
- `next/README.md`
- `next/guidelines.md`
- `next/register.md`
- `next/rules.md`
- `nojs-menu.md`
- `status.md`
as well as these files:
- `bin/gen-top-html.sh`
- `bin/md2html.cfg`
and added:
- `next/submit.html`
- `next/submit.md`
Perform `make www` and `make gen_status` to perform the above and test under macOS.
TODO: Add images about the mailing list to `next/register.md`. See the line:
```
XXX - **put images and other details about joining the mailing list here** - XXX
```
Added a new `next/register.html` that is required by the mailing list server.
The `next/register.md` still contains a big **XXX - put more data here - XXX**
as a placeholder for information about the mailing list registration process.
Improved the status text for `faq.html`, `next/index.html` and `status.html`
via `faq.md`, `next/README.md` and `status.md`. We also removed the
excessive links to IOCCC and instead use the term "contest" where applicable.
IMPORTANT CHANGE: Registration be available when the contest is both pending and open.
We made a number of changes to `faq.md`, `next/README.md` in an attempt to
reflect the above.
Changed `bin/gen-status.sh` VERSION from "1.7 2024-09-23"
to "1.8 2024-11-23".
Changed `bin/gen-top-html.sh` VERSION from "1.4.9 2024-08-11"
to "1.4.10 2024-11-23".
Perform `make www` and `make gen_status` to perform the above and test under macOS.
TODO: Change **XXX - put more data here - XXX** in `next/register.md` for information
about how to join the mailing list.
At least one link in the FAQ was fixed (not to a file but a named
reference). The FAQ has not been checked entirely for broken links
because the changes have got a bit out of hand and an entire make www
will have to be performed due to a problem I discovered doing the below.
Other improvements were made.
When going through the FAQ for broken links another problem was
discovered, one that broke the scripts that rely on jstrdecode(1). These
have been fixed but need further testing with make www. Some index.html files
were modified; for why this can be done without make quick_readme2index
see below on what changed and why it could be done this way.
When going through the FAQ for broken links I discovered some
issues with some entries' synopsis. This means that a number of
index.html and .entry.json files have been updated. The reason the
index.html files could be modified without running the scripts which
would were broken due to the jstrdecode(1) issue (a missing option in
the scripts) is because I used sgit(1). However, a single README.md file
was modified and the index.html file was not modified just yet. That
will happen with make www. The change is not significant, however, so
this should be okay this time. As the next step is a long process I
therefore decided to commit these things to get them out of the way to
try and prevent the commit from being even larger.
Minor fixes in next/try.sh and next/try.alt.sh were also discovered when
going through the FAQ.
Minor typos were made in the FAQ.
The .gitignore file was also updated: with the last change I
accidentally made it so vim swap files without a filename are not
ignored. That means there have to be two vim swap file globs.
New screenshots have been added with new explanations. A couple files
were either deleted or renamed.
There were some fixes as well.
I have looked at the result on the web server and it appears to look and
read well and hopefully this will suffice for this part of the how to
submit FAQ.
It might be worth pointing out that the screenshots might be better
done. For instance some of the longer lines are in some cut off. This
was to try and fit it in smaller screens but it might not be desirable.
Another issue is the scaling of one of the smaller images might make it
too small, at least for people like me who are practically blind.
The wording could definitely be improved as well but I wanted this
initial update in so it can be looked at better and any improvements
necessary can be discussed.
Cody Boone Ferguson