Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhancement: Perform the Great Fork Merge #2239

Open
24 of 66 tasks
lcn2 opened this issue Mar 6, 2024 · 218 comments
Open
24 of 66 tasks

Enhancement: Perform the Great Fork Merge #2239

lcn2 opened this issue Mar 6, 2024 · 218 comments
Assignees
Labels
enhancement New feature or request top priority This a top priory critical path issue for next milestone

Comments

@lcn2
Copy link

lcn2 commented Mar 6, 2024

The Great Fork Merge

The Great Fork Merge will occur when the multi-thousand commits that the temp-test-ioccc repo is ahead of the Official IOCCC winner repo are bright back to main Official www.ioccc.org web site.

TODOs

In order to perform the Great Fork Merge, the following tasks need to be completed:

  • Revise status.json format.

  • Write a new tool to generate the new top level status.html from status.json

NOTE: This may require a rewrite of the bin/ioccc-status.sh tool as well change the format of the from status.json file.

  • Fix name www under RHEL 9

Port the bin tools tools to run under RHEL 9 version of Linux. With this port, the IOCCC judges should be able to use these tools on a wide enough variety of systems for their purposes.

See also comment 1993767060.

See comment 9192931.

  • Verify that the top level README.md contains suitable content for a GitHub repo README file.

The exception, of course, is the initial text down to the XXX that indicates this is a test repo.

Improve the look and feel of the constructed HTML files.

Reorganize the FAQ.

Prepare the mkiocccentry repo for a code freeze and release.

  • Reformat JSON indented with multiples of 4 ASCII spaces and no TABs

See also GH-issue 931 from that other repo.

NOTE: JSONPath.sh with only -S -A and without -T may be helpful with this coversion.

NOTE: The bin/jprint-wrapper.sh tool should also be updated.

This will be in keeping with the completed TODO the JSON indented with multiples of 4 ASCII spaces and no TABs.

  • Review and improve bin/README.md

Now that man pages for bin/ tools (issue #2009) are not planned, we need to review and likely improve the bin/README.md documentation.

We need to add some notes about these recent additions:

  • bin/all-jfmt.sh
  • bin/combine_author_handle.sh
  • bin/jval-wrapper.sh
  • bin/manifest.csv.entry.awk
  • bin/manifest.entry.json.awk
  • Create a new issue for recovery of very old entries in news.md

Issue #2686 was created to satisfy this TODO item.

  • Build bin tools making manifest.numbers no longer necessary and make .entry.json the primary "entry data truth"

See comment-2189364148.

  • Add an FAQ about how to handle de-obfuscated code

See comment 919283.

See comment-2198635072.

This TODO was changed from referring to a "spoiler" into a "de-obfucated" educational emphasis. In that regard we should NOT use terms like "spoiler" in the FAQ as well as NOT using "spoiler" in the entry's README.md file.

At a most, README.md should suggest that the reader might wish to study the prog.c code first before going on to review the de-obfuscated "alt" code.

See also comment-2198807715.

After completing the FAQ entry how to handle de-obfuscated code, consider if needed, revising entries with existing de-obfuscated code AND if needed, fixing cases where the entry README.md makes reference to something being a spoiler.

  • While OT, create an issue for a that performs JSON semantical checks on the .entry.json files in mkioccentey repo

See comment-2172105426 and see comment-2174364721.

  • While OT, fork the jparse/ directory from mkioccentey repo tree into @xexyl's jparse tree

See comment-2197371351.

  • Create an initial text for details of the registration process as a new FAQ 1.4

Add a "see also" link to the new FAQ 1.4 in FAQ 0.0 subsection 2.

If the registration process is not "screenshot ready" by the time this TODO is addressed, put in a "stay tuned for images" placeholder into this new FAQ.

  • Create an initial text for details of the submit process as a new FAQ 1.5

Add a "see also" link to the new FAQ 1.4 in FAQ 0.0 subsection 5.

If the ** submit process** is not "screenshot ready" by the time this TODO is addressed, put in a "stay tuned for images" placeholder into this new FAQ.

  • Carefully reread and review the next rules and guidelines

  • Carefully reread and review the FAQ

In addition to the useful check for typos, wording, and broken links: review for suitability for gong live with on the main web site after the Great Fork Merge. Update faq.md if and as needed.

  • Cleanup from 2024 testing

We need to cleanup from testing tools, so we need to remove:

  • 2024 from .gitignore
  • 2024 from .top
  • 2024 from Makefile

These may have added as part of tool testing and need to be removed before we proceed along the Great Fork Merge process below.

  • Inspect and sanity check the remaining TODO items

Add, modify and/or remove things from the remaining TODOs if/as needed.

  • Determine that we are ready to perform the Great Fork Merge

  • Announce a code freeze

In a comment in this issue #2239, announcers that general pull requests for the temp-test-ioccc repo will no be accepted and that we are beginning work on the Near Final TODOs.

Getting ready for the Near Final TODOs

NOTE: Once the above TODOs have been completed, the following last minute TODO actions must be completed in relatively short order (preferably in the same calendar day) before the Great Fork Merge takes place.

  • Remove all trailing whitespace from markdown files

Use this to look for any whitespace from markdown files

find . -name '*.md' -print0 | xargs -0 grep -E -l '[[:space:]][[:space:]]*$'
  • Verify the markdown code blocks are properly indented

Use:

find . -name '*.md' ! -name markdown.md -print0 | xargs -0 pcregrep -M '^``.*\n[^|`\n \t]'
  • Verify that the Nu Html Checker finds no errors, warnings nor info messages for all generated HTML

After making sure that the temp-test-ioccc repo is up to date and related GitHub pages have been rendered, use the ✓ on the navbar to check all generated HTML pages.

Fix any errors, warnings and info messages reported. Update the temp-test-ioccc repo and recheck those pages.

  • Update FAQ 1.2 with there date of Great Fork Merge

In FAQ 1.2, look for the <!-- XXX - Fill in the date when Great Fork Merge happens --> and update the date as for that section as needed.

Change default URLs and REPOs to refer to the https://www.ioccc.org web site and winner repo.

  • Change references to use www.ioccc.org instead of temp-test-ioccc

Change references as needed given their context.

This includes markdown files, HTML files, var.mk, Makefiles, text files, etc.

Try:

make www
find . \( -name .git -o -name NOTES \) -prune -o -type f -print0 | xargs -0 grep -l -F temp-test-ioccc

Also change the comment in var.mk

  • In mkiocccentry repo, Change references to use www.ioccc.org instead of temp-test-ioccc

See GH-#issuecomment-2403175498.

  • Re-release the mkiocccentry repo

  • Rebuild web tree via make www

  • Scan repo to verify that references to temp-test-ioccc have been processed.

The only exceptions should be historic references found in news.md, news.hml, faq.md and faq.html.

  • Add news event to news.md announcing the new www.ioccc.org web site.

Edit news.md as needed.

Perform make www and commit any changes.

Near Final TODOs

NOTE: Once the above TODOs have been completed, the following last minute TODO actions must be completed in relatively short order (preferably in the same calendar day) before the Great Fork Merge takes place.

  • Verify that the installed location(1) tool is up to date

Be sure the mkiocccentry repo is up to date and perform a make install in that typo.

  • Purge repo of previous *.tar.bz2 files and reduce Git repository size

See GH-issuecomment-2430718370 for a summary of the test process.

We will perform the following actions:

git mv 2011/dlowe/dlowe-aux-data.tar.bz2 HOLD
git commit -m'move dlowe-aux-data.tar.bz2 to HOLD'

git remote -v
git filter-repo --path-glob '????/*.tar.bz2' --invert-paths --force
git remote add origin [email protected]:lcn2/trim-temp-test-ioccc.git

git mv HOLD 2011/dlowe/dlowe-aux-data.tar.bz2
git commit -m'move HOLD back to dlowe-aux-data.tar.bz2'

for year in [12][0-9][0-9][0-9]; do
  touch "$year/$year.tar.bz2"; git add "$year/$year.tar.bz2";
done

for year in [12][0-9][0-9][0-9]; do
  for dir in $(< "$year/.year"); do
    entry_id=${dir/\//_};
    touch "$dir/$entry_id.tar.bz2";
    git add "$dir/$entry_id.tar.bz2";
  done;
done

git commit -m'add empty tar.bz2 files until we do make update'

git repack
git prune-packed
git reflog expire --expire=now --all
git gc --aggressive --prune=now
git fsck --full

git push --all --force
git push --tags --force
git push --set-upstream origin master

FYI: See:

NOTE: The make update in a TODO farther below will add back the needed *.tar.bz2 files.

NOTE: The make gen_years will generate Warnings of the form: "bin/gen-years.sh: Warning: compressed tarball for YYYY: yyyy is empty: yyyy/yyyy.tar.bz2".

This is OK and will be corrected once make update or make tar is done.

  • Perform make update on macOS and push out any changes

  • Verify that running make update again on macOS changes only:

  • sitemap.xml
  • status.html
  • status.json

If so, then revert those changes by:

git restore sitemap.xml status.html status.json

If not, reset all TODOs under the Near Final TODOs section and fix the cause.

  • Verify make www on RHEL 9 changes nothing

If not, reset all TODOs under the Near Final TODOs section and fix the cause.

  • update README.md and index.md

Remove the lines between:

<!-- XXX - This entire section goes away during the final stages of the Great Fork Merge -->

and:

<!-- XXX - remove down to here in the final stages of the Great Fork Merge -->

Verify that:

git status

reports:

On branch master
Your branch is up to date with 'origin/master'.

nothing to commit, working tree clean

Fetch any last minute changes:

cd docroot/temp-test-iocc

git fetch && git rebase

git clean -f

git status

The last command should report:

On branch master
Your branch is up to date with 'origin/master'.

nothing to commit, working tree clean
  • Perform make update on macOS

  • Commit all changes and push the result to the temp-test-ioccc repo

git commit -m'final pre-Great Fork Merge'

git push

Fetch any last minute changes:

cd docroot/temp-test-iocc

git fetch && git rebase

git clean -f

git status

The last command should report:

On branch master
Your branch is up to date with 'origin/master'.

nothing to commit, working tree clean
  • Re-Verify make update on macOS changes * [ ] Verify that running make update again on macOS changes only:
  • sitemap.xml
  • status.html
  • status.json

If so, then revert those changes by:

git restore sitemap.xml status.html status.json

If not, reset all TODOs under the Near Final TODOs section and fix the cause.

  • Re-Verify make www on RHEL 9 changes nothing

If not, reset all TODOs under the Near Final TODOs section and fix the cause.

FINAL REVIEW

  • Pause and ask for a review of readiness

We expect this period to be between 2024 November 1 and 2024 November 15.

Please review the effect of all of the above completed to do. Please limit PRs to only critical problems, and broken links, and linked to the wrong file, and failure to the official website and repo, etc.

  • Incorporate any PRs as a result of the previously mentioned review

Accept any such PRs, if needed modify the result after accepting, and finally do a make update.

Great Fork Merge

  • Perform the Great Fork Merge

Click Create Pull Request for the Official IOCCC winner repo.

Inspect the pull request for the Official IOCCC winner repo.

Accept and complete the pull request.

Post Great Fork Merge TODOs

Once the Great Fork Merge occurs and the official IOCCC winner repo and related Official www.ioccc.org web site has been updated, these TODOs need to be performed on the official IOCCC winner repo:

Close down issue #2686 as "won't fix" in this repo.

Fix any problems found on the Official www.ioccc.org web site by editing the official IOCCC winner repo as needed.

  • Announce on Mastodon that the Great Fork Merge has happened and the official IOCCC web site has been updated

  • Mark the temp-test-ioccc repo read-only

From temp-test-ioccc repo settings click on the ((Archive this repository)) button.

This will Freeze the temp-test-ioccc repo but leave it in place for historic purposes.

@lcn2 lcn2 added the enhancement New feature or request label Mar 6, 2024
@lcn2 lcn2 self-assigned this Mar 6, 2024
@xexyl
Copy link

xexyl commented Mar 6, 2024

Please assign this to me.

And as I noted before: if needed I would like to update my script that updates the status.json file.

Thanks.

I will have to look at this issue later on today as it seems rather important!

@xexyl
Copy link

xexyl commented Mar 6, 2024

Also I am not sure if I can finish the year README files before the 10th but I should be able to finish them sometime soon anyway.

But for now I must go do other things again. Back in a while.

@xexyl
Copy link

xexyl commented Mar 6, 2024

In order to perform the Great Fork Merge, the following tasks need to be completed:

  • Revise status.json format.
  • Write a new tool to generate the new top level status.html from status.json

NOTE: This may require a rewrite of the bin/ioccc-status.sh tool as well change the format of the from status.json file.

It's funny you should say that .. the generating the file. Do you mean creating the file rather than modifying it? I actually had the thought of adding an option to the script to do that and I seem to recall that I almost did do it. It would be easy to do. But since the format is not necessarily the final format I will hold off on that.

The anticipated completion date for this issue is 2024 March 10 2:30 (2:30AM) Pacific.

Like I said over there mostly it is done: except for the YYYY/README.md files. But I can do those after 10 March if necessary so I have no problem with it being closed. You were going to take care of the silencing the warnings and right now would be fine as I don't anticipate modifying any Makefiles or if I'm honest for now anything at all (except maybe the FAQ which you asked me to look at). That probably will hold for a day or two at least but even if I do make other changes it'll likely only be the YYYY/README.md files. I say I might not finish it before 10 March but I might yet: I just have to have the energy and time and the former seems to be a problem lately I'm afraid. Even so I might be able to do some of it today: that remains to be seen however.

Okay in order to do this I think I even created a new repo to test how this works. I think the other issues should come first though. Is that correct?

Ah yes ... I forgot. I have to update descriptions and also check the html files! It's been very hectic and I totally forgot about this. I was also holding off as you were planning many changes that would conflict. Those changes are now done so I can look at this sometime soon too. If I don't please remind me.

Right ... well this one might be good to look at when I look at the manifest too. After all the result of the manifest is in the index.html files.

Well some of this cannot be done until the submit server is ready, right?

Near Final TODOs

Once the above TODOs have been completed, the following last minute TODO actions must be completed in relatively short order before the Great Fork Merge takes place:

In the (few?) cases where a absolute URL is required, change that URL to be under https://www.ioccc.org and NOT this repo's top level URL.

sgit(1) should be useful for this one! :)

Edit news.md as needed.

That's a great idea .. looking forward to see what you have in mind! Almost eager enough to try and get myself to work on YYYY/README.md files today but I think that might be a mistake with how tired I feel :(

  • Verify that the installed location(1) tool is up to date

How do you mean verify that it's up to date? Do you mean locally installed? But what version should it be then? Did you have other updates in mind? (I in any case have the most recent version at the other repo.) Then again perhaps this is something you have to do so I might not have to worry about it. Or maybe a tool here uses it and I do have to worry about it. But as noted I do have them installed so it's fine.

  • Verify manifest.numbers agrees with the local temp-test-ioccc repo

How do you mean verify that it agrees with it when it's in the repo? Though again I guess this might have to be something you do so I don't need to worry about it: updating the manifest I do have to worry about but perhaps not this step?

Perform the 12 steps as noted in comment 2089758002.

Don't forget the script I wrote! It's very useful. By default it does not commit automatically but there is an option to allow it to do so. It even asks if you're on the right branch.

  • Remove tmp directory.

Ever notice what tmp spells backwards? :-)) Well okay it is a British English abbreviation but still :-)

Post Great Fork Merge TODOs

Once the Great Fork Merge occurs and the official IOCCC winner repo and related Official www.ioccc.org web site has been updated, these TODOs need to be performed on the official IOCCC winner repo:

I've enjoyed this one though I must say! A lot of good things, a lot of fun, a lot of laughs and stories and other things ... thanks for the privilege and honour!

Good idea.

  • Mark the temp-test-ioccc repo read-only

From temp-test-ioccc repo settings click on the ((Archive this repository)) button.

THANK YOU for going for that (as I suggested) rather than deleting it.

  • Verify site links work
    Ah yes .. that'll be fun! :-)

Process TBD.

Fix any problems found as needed.

Of course.

At the other repo I left a comment regarding an issue I have (about finishing something we talked about the other day) but I think that and this comment is probably all I'll manage to do today for the contest. But who knows. I might be able to take a look at some things at this repo too. For now I'll be afk (or I intend to be afk soon). I think today though I will mostly be reading when not doing the things I have to do.

@lcn2
Copy link
Author

lcn2 commented Mar 6, 2024

Incomplete TODO

NOTICE: This TODO list will be built over a few days. Until this notice is removed, consider this list to be incomplete.

:-)

=-=

  • Revise status.json format.
  • Write a new tool to generate the new top level status.html from status.json

NOTE: This may require a rewrite of the bin/ioccc-status.sh tool as well change the format of the from status.json file.
It's funny you should say that .. the generating the file. Do you mean creating the file rather than modifying it?

The content of status.json is still TBD, and so is the tool that will mange it.

=-=

The anticipate completion date for this issue is 2024 March 10 2:30 (2:30AM) Pacific.

Like I said over there mostly it is done: except for the YYYY/README.md files. But I can do those after 10 March if necessary so I have no problem with it being closed.

Sure.

BTW: issue #2006 does indicate that it covers such files, and the title has been changed to say "constructed HTML files".

@lcn2
Copy link
Author

lcn2 commented Mar 6, 2024

Okay in order to do this I think I even created a new repo to test how this works. I think the other issues should come first though. Is that correct?

It is a ((*top priority)) issue and has been for a while. It pertains to something that is much needed after the Great Fork Merge when people start considering opening up issues on the revised web site.

=-=

Well some of this cannot be done until the submit server is ready, right?

We will need to put in some placeholder text that indicates the exact process has not been created, but will be before the IOCCCMOCK is held.

=-=

  • Verify that the installed location(1) tool is up to date

How do you mean verify that it's up to date? Do you mean locally installed? But what version should it be then? Did you have other updates in mind? (I in any case have the most recent version at the other repo.) Then again perhaps this is something you have to do so I might not have to worry about it. Or maybe a tool here uses it and I do have to worry about it. But as noted I do have them installed so it's fine.

As we need to be the one be performing these last steps, you @xexyl do not need to worry about the details.

=-=

  • Remove tmp directory.

Ever notice what tmp spells backwards? :-)) Well okay it is a British English abbreviation but still :-)

:-)

@xexyl
Copy link

xexyl commented Mar 7, 2024

Okay in order to do this I think I even created a new repo to test how this works. I think the other issues should come first though. Is that correct?

It is a ((*top priority)) issue and has been for a while. It pertains to something that is much needed after the Great Fork Merge when people start considering opening up issues on the revised web site.

Let me reword that. Besides #3 (and I hope I can look at some of it today in a while but we shall see) do you have an order of priority for the remaining issues or should it be 'whatever I have the time and energy and inclination for'?

That idea of whatever I can work on would be useful but if you have an order I could try and work with it.

=-=

Well some of this cannot be done until the submit server is ready, right?

We will need to put in some placeholder text that indicates the exact process has not been created, but will be before the IOCCCMOCK is held.

That all makes sense to me yes. Thanks.

=-=

  • Verify that the installed location(1) tool is up to date

How do you mean verify that it's up to date? Do you mean locally installed? But what version should it be then? Did you have other updates in mind? (I in any case have the most recent version at the other repo.) Then again perhaps this is something you have to do so I might not have to worry about it. Or maybe a tool here uses it and I do have to worry about it. But as noted I do have them installed so it's fine.

As we need to be the one be performing these last steps, you @xexyl do not need to worry about the details.

I guessed that but I wanted to be sure.

=-=

  • Remove tmp directory.

Ever notice what tmp spells backwards? :-)) Well okay it is a British English abbreviation but still :-)

:-)

:-) :-)

@lcn2
Copy link
Author

lcn2 commented Mar 8, 2024

Let me reword that. Besides #3 (and I hope I can look at some of it today in a while but we shall see) do you have an order of priority for the remaining issues or should it be 'whatever I have the time and energy and inclination for'?

After closing issue #3 , the next priorities will be issue #1933, then issue #2006 , then issue #858 .

We home this clarifies @xexyl .

We will be mostly offline for about 2-3 days working on issue #2008 as well as prep actions for this issue.

@xexyl
Copy link

xexyl commented Mar 9, 2024

Let me reword that. Besides #3 (and I hope I can look at some of it today in a while but we shall see) do you have an order of priority for the remaining issues or should it be 'whatever I have the time and energy and inclination for'?

After closing issue #3 , the next priorities will be issue #1933, then issue #2006 , then issue #858 .

I presume that this is in order and not equal priority - given that you say 'then' and 'then'?

We home this clarifies @xexyl .

Hopefully :-) it does .. yes it does - thanks!

We will be mostly offline for about 2-3 days working on issue #2008 as well as prep actions for this issue.

Best wishes! Today I'm not doing anything for the contest I'm afraid. Having a very off day. Tomorrow i'm sure will be better.

@lcn2
Copy link
Author

lcn2 commented Mar 9, 2024

After closing issue #3 , the next priorities will be issue #1933, then issue #2006 , then issue #858 .
I presume that this is in order and not equal priority - given that you say 'then' and 'then'?

Correct, @xexyl

@xexyl
Copy link

xexyl commented Mar 10, 2024

After closing issue #3 , the next priorities will be issue #1933, then issue #2006 , then issue #858 .
I presume that this is in order and not equal priority - given that you say 'then' and 'then'?

Correct, @xexyl

Thanks. I want to be sure of something before I finish my part of #3 which I'll ask you there. My part left in that is minimal except of course for checking typos etc. in the FAQ and other like files so that's good. But I won't be doing anything today. Depending on when you get back to me on the concern and the answer too I hopefully can start tomorrow.

@lcn2
Copy link
Author

lcn2 commented Mar 10, 2024

After closing issue #3 , the next priorities will be issue #1933, then issue #2006 , then issue #858 .
I presume that this is in order and not equal priority - given that you say 'then' and 'then'?

Correct, @xexyl

Thanks. I want to be sure of something before I finish my part of #3 which I'll ask you there. My part left in that is minimal except of course for checking typos etc. in the FAQ and other like files so that's good. But I won't be doing anything today. Depending on when you get back to me on the concern and the answer too I hopefully can start tomorrow.

Best wishes, @xexyl

@xexyl
Copy link

xexyl commented Mar 10, 2024

After closing issue #3 , the next priorities will be issue #1933, then issue #2006 , then issue #858 .
I presume that this is in order and not equal priority - given that you say 'then' and 'then'?

Correct, @xexyl

Thanks. I want to be sure of something before I finish my part of #3 which I'll ask you there. My part left in that is minimal except of course for checking typos etc. in the FAQ and other like files so that's good. But I won't be doing anything today. Depending on when you get back to me on the concern and the answer too I hopefully can start tomorrow.

Best wishes, @xexyl

Should be good: I'm going to soon get back to LR! And you too!

@lcn2
Copy link
Author

lcn2 commented Mar 10, 2024

With commit 449205e the new status.json model is complete.

The first 2 TODO items of this issue #2239 have been completed.

@lcn2
Copy link
Author

lcn2 commented Mar 10, 2024

We will next focus on issue #2008 as that issue is somewhat independent of the other ((Top
Priority
)) issues.

@lcn2
Copy link
Author

lcn2 commented Mar 11, 2024

We will next focus on issue #2008 as that issue is somewhat independent of the other ((Top Priority)) issues.

Issue #2008, as per comment 1987654095 and commit f482380 has been completed.

@lcn2
Copy link
Author

lcn2 commented Mar 15, 2024

We made more tweaks to the TODO list for this issue.

We think the TODO list is nearly ready.

UPDATE 0

Comments and corrections welcome.

@lcn2
Copy link
Author

lcn2 commented Mar 15, 2024

We believe we have addressed all of the current questions that still need answering at this time. If we've missed something or something else needs to be clarified, please ask again.

@xexyl
Copy link

xexyl commented Mar 15, 2024

We believe we have addressed all of the current questions that still need answering at this time. If we've missed something or something else needs to be clarified, please ask again.

I will have to get back to this tomorrow and determine that. I'm sure you did though.

@lcn2
Copy link
Author

lcn2 commented Mar 18, 2024

With commit 4471875 the bin tools have been ported to RHEL 9.

The make quick_www and make www should work well under Linux, assuming that up to date critical tools such as location(1), jparse(1) are installed and assuming that pandoc(1) has ben installed with a minimum 3.1.12.2 version, and when bash(1) found by #!/usr/bin/env bash is version 5.1.8 or later.

UPDATE 0

The TODO list has been updated accordingly.

@xexyl
Copy link

xexyl commented Mar 18, 2024

With commit 4471875 the bin tools have been ported to RHEL 9.

The make quick_www and make www should work well under Linux, assuming that up to date critical tools such as location(1), jparse(1) are installed and assuming that pandoc(1) has ben installed with a minimum 3.1.12.2 version, and when bash(1) found by #!/usr/bin/env bash is version 5.1.8 or later.

UPDATE 0

The TODO list has been updated accordingly.

Well now I ran into a new problem. Don't you use pandoc from Homebrew? If so: I updated it yesterday and it's not a high enough version for running the make www. Where do you get it from then? Thanks.

@xexyl
Copy link

xexyl commented Mar 18, 2024

With commit 4471875 the bin tools have been ported to RHEL 9.
The make quick_www and make www should work well under Linux, assuming that up to date critical tools such as location(1), jparse(1) are installed and assuming that pandoc(1) has ben installed with a minimum 3.1.12.2 version, and when bash(1) found by #!/usr/bin/env bash is version 5.1.8 or later.

UPDATE 0

The TODO list has been updated accordingly.

Well now I ran into a new problem. Don't you use pandoc from Homebrew? If so: I updated it yesterday and it's not a high enough version for running the make www. Where do you get it from then? Thanks.

Oh I know why. I have it from MacPorts too. My guess is it'll be a problem to remove it so I have to maybe put the Homebrew path before the MacPorts path.

UPDATE 0

All good it seems. Thanks. I can now look at the comments in the other issue and hopefully get them done in the next few days. Right now though I must go again. It is unclear to me yet if I can do much today or anything at all but at least last night was better than the previous three nights! Hopefully that continues.

@lcn2
Copy link
Author

lcn2 commented Mar 20, 2024

Priorities

Regarding the top priory open issues:

While going thru the IOCCC manifest, reviewing the data fields from the manifest.numers spreadsheet:

  • inventory_order
  • OK_to_edit
  • display_as
  • display_via_github
  • entry_text

Look at each entry's inventory, as found in index.html#inventory to see how the contents are being expressed. Look at the sorted lines in the manifest.numers spreadsheet that relate to the entry in question.

Because issue #1933 and issue #2006 are somewhat intertwined @xexyl, we suggest you process both them at the same time. Like you did for issue #3, you can announce your progress on an IOCCC year by YEAR basis.

Regarding issue #2006

And since one is looking a an entry's inventory, give a glance over the rest of the index.html page.

Here are the types of questions, @xexyl, to ask yourself, does the index.html page contain:

  • Some formatting that looks obnoxious?
  • Information displayed in way that is difficult to read?
  • Have too much to too little whitespace that makes the web page awkward to read?

We are NOT focusing on the accuracy of the index.html page per se (although if you see something glaring, feel free to fix it under the guide of something that slipped passed the issue #3 effort). We are focusing on HOW it LOOKS with an emphasis on correcting dysfunctional presentations.

In nearly all cases, corrections can be addressed by editing the entry's README.md file. Please modify the entry's README.md file and re-build the entry's index.html in a pull request.

If, however, you see an issue that may be more a matter of changing ioccc.css or the related bin tool, please raise the matter as a comment in this issue #2239 so we can discuss the matter before editing the CSS and/or bin tool. Again, this is less likely to happen, but if it does, we recommend a comment related discussion first. Modification to the entry's README.md file can be done directly via pull requests.

Regarding issue #1933

Here are the types of questions, @xexyl, to ask yourself:

  • Are the brief (59 characters or less) descriptions accurate or at least somewhat useful?

See the entry_text field in the manifest.numers spreadsheet.

See also the Manifest fields section of the top comment of issue 1933.

  • Is the order listed reasonable?

See the inventory_order field in the manifest.numers spreadsheet.

See also the Manifest fields section of the top comment of issue 1933.

  • The the more useful files to look at in the Primary files section? (see inventory_order)

See the inventory_order field in the manifest.numers spreadsheet.

See also the Manifest fields section of the top comment of issue 1933.

  • Are files that are built by bin tools marked as false for _ OK_to_edit_?

See the OK_to_edit field in the manifest.numers spreadsheet.

See also the Manifest fields section of the top comment of issue 1933.

  • Are files that marked as true or _ OK_to_edit_ files not created by bin tools nor Makefile rules?

See the OK_to_edit field in the manifest.numers spreadsheet.

See also the Manifest fields section of the top comment of issue 1933.

  • Is the general type of file consistent across similar classes of file types?

See the display_as field in the manifest.numers spreadsheet.

See also the Manifest fields section of the top comment of issue 1933.

  • Do files that need to be dowloaded (instead of viewed), downloading in a browser?

See the display_via_github field in the manifest.numers spreadsheet.

See also the Manifest fields section of the top comment of issue 1933.

  • Do files that need to be viewed (such as C code, Makefiles, etc.) via GitHub going to the GitHub site?

See the display_via_github field in the manifest.numers spreadsheet.

See also the Manifest fields section of the top comment of issue 1933.

  • Are files that we OK to be viewed directly in a browser (such as images, photos, etc.) workin in the browser?

See the display_via_github field in the manifest.numers spreadsheet.

See also the Manifest fields section of the top comment of issue 1933.

See the Manifest fields section of the top TODO comment for issue #1933 for more information.

Comments, Suggestions as Questions welcome

Any Comments, Suggestions as Questions you may have about this comment are welcome.

@lcn2
Copy link
Author

lcn2 commented Mar 20, 2024

As per comment 2010767087, this TODO item has been marked complete:

  • Verify that the format of markdown files is good

@lcn2
Copy link
Author

lcn2 commented Oct 22, 2024

Another TODO after the merge.

I see in the mkiocccentry tool the answers file version refers to MOCK:

#define MKIOCCCENTRY_ANSWERS_VERSION "MKIOCCCENTRY_ANSWERS-IOCCCMOCK-1.0"

.... and I see a grammatical fix in need too so if you'd like me to fix that, let me know what you want the version string to be and I'll be happy to do that when you wish.

One suggestion

One possible version string would be:

MKIOCCCENTRY_ANSWERS_IOCCC28

.. or something along those lines.

Please use MKIOCCCENTRY_ANSWERS_IOCCC28.

@xexyl
Copy link

xexyl commented Oct 22, 2024

Another TODO after the merge.
I see in the mkiocccentry tool the answers file version refers to MOCK:

#define MKIOCCCENTRY_ANSWERS_VERSION "MKIOCCCENTRY_ANSWERS-IOCCCMOCK-1.0"

.... and I see a grammatical fix in need too so if you'd like me to fix that, let me know what you want the version string to be and I'll be happy to do that when you wish.

One suggestion

One possible version string would be:
MKIOCCCENTRY_ANSWERS_IOCCC28
.. or something along those lines.

Please use MKIOCCCENTRY_ANSWERS_IOCCC28.

Let me know when you wish to be done.

@lcn2
Copy link
Author

lcn2 commented Oct 22, 2024

Another TODO after the merge.
I see in the mkiocccentry tool the answers file version refers to MOCK:

#define MKIOCCCENTRY_ANSWERS_VERSION "MKIOCCCENTRY_ANSWERS-IOCCCMOCK-1.0"

.... and I see a grammatical fix in need too so if you'd like me to fix that, let me know what you want the version string to be and I'll be happy to do that when you wish.

One suggestion

One possible version string would be:
MKIOCCCENTRY_ANSWERS_IOCCC28
.. or something along those lines.

Please use MKIOCCCENTRY_ANSWERS_IOCCC28.

Let me know when you wish to be done.

We think you can safely do that now.

UPADTE 0

That will also git you a change to test in the "other repo":

make all.recreate_clone && make all.update_from_clone && git status && make release

@xexyl
Copy link

xexyl commented Oct 22, 2024

Another TODO after the merge.
I see in the mkiocccentry tool the answers file version refers to MOCK:

#define MKIOCCCENTRY_ANSWERS_VERSION "MKIOCCCENTRY_ANSWERS-IOCCCMOCK-1.0"

.... and I see a grammatical fix in need too so if you'd like me to fix that, let me know what you want the version string to be and I'll be happy to do that when you wish.

One suggestion

One possible version string would be:
MKIOCCCENTRY_ANSWERS_IOCCC28
.. or something along those lines.

Please use MKIOCCCENTRY_ANSWERS_IOCCC28.

Let me know when you wish to be done.

We think you can safely do that now.

What about jparse (once the test part is fixed)? I would think it's not needed or even useful but since I'm working on that right now ..

@xexyl
Copy link

xexyl commented Oct 22, 2024

I updated the version string. Did not update the release number. Feel free to do that if you wish.

@lcn2
Copy link
Author

lcn2 commented Oct 23, 2024

We tested how to remove *.tar.bz2 files from under YYYY directories.

BTW: This will not remove the /archive/historic/archive-*.tar.bz2 files, nor 2011/dlowe/dlowe-aux-data.tar.bz2.

To test, we cloned the temp-test-ioccc repo into https://github.com/lcn2/trim-temp-test-ioccc.

Then using that cloned trim-temp-test-ioccc repo we did:

git mv 2011/dlowe/dlowe-aux-data.tar.bz2 HOLD
git commit -m'move dlowe-aux-data.tar.bz2 to HOLD'

git remote -v
git filter-repo --path-glob '????/*.tar.bz2' --invert-paths --force
git remote add origin [email protected]:lcn2/trim-temp-test-ioccc.git

git mv HOLD 2011/dlowe/dlowe-aux-data.tar.bz2
git commit -m'move HOLD back to dlowe-aux-data.tar.bz2'

for year in [12][0-9][0-9][0-9]; do
  touch "$year/$year.tar.bz2"; git add "$year/$year.tar.bz2";
done

for year in [12][0-9][0-9][0-9]; do
  for dir in $(< "$year/.year"); do
    entry_id=${dir/\//_};
    touch "$dir/$entry_id.tar.bz2";
    git add "$dir/$entry_id.tar.bz2";
  done;
done

git commit -m'add empty tar.bz2 files until we do make update'

git repack
git prune-packed
git reflog expire --expire=now --all
git gc --aggressive --prune=now
git fsck --full

git push --all --force
git push --tags --force
git push --set-upstream origin master

NOTE: We plan to do this for the temp-test-ioccc repo after issue #2006 and issue #268 are closed. Then during the later parts of the Great Fork Merge, we do a make update and add new *.tar.bz2 that will reflect the current stage of the repo. Thus, the repo will have all *.tar.bz2 files needed AND ONLY the *.tar.bz2 files for the Great Fork Merge.

The effect of the test, and after going a make update is:

Reduce git fullfsck (git fsck --full) from 0.32s system 99% cpu 3.937 total to 2.43s user 0.21s system 99% cpu 2.654 total.

Reduce the repo size from +1.5G (1489856k) to only 0.93G (949308k).

Reduce the time it takes to clone from "6.37s user 6.22s system 23% cpu 53.056" to just "4.20s user 3.36s system 28% cpu 26.861 total".

UPDATE 0a

Now that we have tested the method, the TODO for this issue has been updated.

See the TODO: "Purge repo of previous .tar.bz2 files and reduce Git repository size" where we have the actual commands we plan to use based on the above tests.

UPDATE 1b

NOTE: The make gen_years will generate Warnings of the form: "bin/gen-years.sh: Warning: compressed tarball for YYYY: yyyy is empty: yyyy/yyyy.tar.bz2". These warnings are OK.

REQUEST

Check out the trim-temp-test-ioccc repo. It contains the result of the "steps" shown above followed by the result of make update. The purpose of this repo is to give you an idea of how this refill will look once those actions were applied.

Of course, doing this action is a very unusual action that actually forces changes into the history of the repo. Those changes are limited to deleting the specific git add .. YYYY/**/something*.tar.gz, with the exception of 2011/dlowe/dlowe-aux-data.tar.bz2 and archive/**/something.tar.bz2.

The loss of those compressed rollup tar balls is minimal. They are simply collections of the existing files, and only serve to burden the people with unnecessary duplicated content.

This is just a test of the process we plan to perform during a near-final state of the Great Fork Merge. We made this fork of a fork of the repo available so you could look at, if you're curious, at the effect of the above mentioned process.

This forest reset of the repo history will require you to te-clone the repo. That is acceptable since once they start, we will be in the final stages of the Great Fork Merge. Moreover, once the Great Fork Merge is complete. The merge into the official IOCCC winner repo will be clean from that perspective.

We do not anticipate having to do this again.

Once you have had a chance to look at trim-temp-test-ioccc repo, we will delete that repo.

Comments welcome.

@lcn2
Copy link
Author

lcn2 commented Oct 23, 2024

We have updated the TODOs for this issue.

REQUEST

Please review the TODOs for this issue. Are there any mistakes? Did we miss anything? etc.

@lcn2
Copy link
Author

lcn2 commented Oct 23, 2024

Once the IOCCC Judges meet on 2024, October 29, and any judge mandated edits are applied, (perhaps to the guidelines and rules) then we will begin the process of entering the final stages of the Great Fork Merge.

@xexyl
Copy link

xexyl commented Oct 23, 2024

Once the IOCCC Judges meet on 2024, October 29, and any judge mandated edits are applied, (perhaps to the guidelines and rules) then we will begin the process of entering the final stages of the Great Fork Merge.

I'd guess the guidelines and rules indeed would be updated. As for the merge: I think you'll be away for a bit before it happens but before that you plan to freeze it so that no changes will be applied. Is this correct?

@xexyl
Copy link

xexyl commented Oct 23, 2024

We tested how to remove *.tar.bz2 files from under YYYY directories.

BTW: This will not remove the /archive/historic/archive-*.tar.bz2 files, nor 2011/dlowe/dlowe-aux-data.tar.bz2.

To test, we cloned the temp-test-ioccc repo into https://github.com/lcn2/trim-temp-test-ioccc.

Then using that cloned trim-temp-test-ioccc repo we did:

git mv 2011/dlowe/dlowe-aux-data.tar.bz2 HOLD
git commit -m'move dlowe-aux-data.tar.bz2 to HOLD'

git remote -v
git filter-repo --path-glob '????/*.tar.bz2' --invert-paths --force
git remote add origin [email protected]:lcn2/trim-temp-test-ioccc.git

git mv HOLD 2011/dlowe/dlowe-aux-data.tar.bz2
git commit -m'move HOLD back to dlowe-aux-data.tar.bz2'

for year in [12][0-9][0-9][0-9]; do
  touch "$year/$year.tar.bz2"; git add "$year/$year.tar.bz2";
done

for year in [12][0-9][0-9][0-9]; do
  for dir in $(< "$year/.year"); do
    entry_id=${dir/\//_};
    touch "$dir/$entry_id.tar.bz2";
    git add "$dir/$entry_id.tar.bz2";
  done;
done

git commit -m'add empty tar.bz2 files until we do make update'

git repack
git prune-packed
git reflog expire --expire=now --all
git gc --aggressive --prune=now
git fsck --full

git push --all --force
git push --tags --force
git push --set-upstream origin master

NOTE: We plan to do this for the temp-test-ioccc repo after issue #2006 and issue #268 are closed. Then during the later parts of the Great Fork Merge, we do a make update and add new *.tar.bz2 that will reflect the current stage of the repo. Thus, the repo will have all *.tar.bz2 files needed AND ONLY the *.tar.bz2 files for the Great Fork Merge.

The effect of the test, and after going a make update is:

Reduce git fullfsck (git fsck --full) from 0.32s system 99% cpu 3.937 total to 2.43s user 0.21s system 99% cpu 2.654 total.

Reduce the repo size from +1.5G (1489856k) to only 0.93G (949308k).

Reduce the time it takes to clone from "6.37s user 6.22s system 23% cpu 53.056" to just "4.20s user 3.36s system 28% cpu 26.861 total".

UPDATE 0a

Now that we have tested the method, the TODO for this issue has been updated.

See the TODO: "Purge repo of previous .tar.bz2 files and reduce Git repository size" where we have the actual commands we plan to use based on the above tests.

UPDATE 1b

NOTE: The make gen_years will generate Warnings of the form: "bin/gen-years.sh: Warning: compressed tarball for YYYY: yyyy is empty: yyyy/yyyy.tar.bz2". These warnings are OK.

REQUEST

Check out the trim-temp-test-ioccc repo. It contains the result of the "steps" shown above followed by the result of make update. The purpose of this repo is to give you an idea of how this refill will look once those actions were applied.

Of course, doing this action is a very unusual action that actually forces changes into the history of the repo. Those changes are limited to deleting the specific git add .. YYYY/**/something*.tar.gz, with the exception of 2011/dlowe/dlowe-aux-data.tar.bz2 and archive/**/something.tar.bz2.

The loss of those compressed rollup tar balls is minimal. They are simply collections of the existing files, and only serve to burden the people with unnecessary duplicated content.

This is just a test of the process we plan to perform during a near-final state of the Great Fork Merge. We made this fork of a fork of the repo available so you could look at, if you're curious, at the effect of the above mentioned process.

This forest reset of the repo history will require you to te-clone the repo. That is acceptable since once they start, we will be in the final stages of the Great Fork Merge. Moreover, once the Great Fork Merge is complete. The merge into the official IOCCC winner repo will be clean from that perspective.

We do not anticipate having to do this again.

Once you have had a chance to look at trim-temp-test-ioccc repo, we will delete that repo.

Comments welcome.

Please let me know what you want me to do when checking the repo. I'll clone it now so I can look at it in the ways you need.

@xexyl
Copy link

xexyl commented Oct 23, 2024

As for the todo list in this issue: there is unfortunately no way I can possible do all of those before the 28th. The checking for the lint would itself take a lot of time and I think the FAQ is more important? But on that note the FAQ itself is very large and to go over it thoroughly (as a toad item says) will take much time. I'm not sure if I can simplify the whole thing much more but I will check that links are good and that the linter has no complaints.

I'm going to look at the FAQ first two or three sections in a short bit but I wanted to reply to this as you requested.

@lcn2
Copy link
Author

lcn2 commented Oct 23, 2024

Once the IOCCC Judges meet on 2024, October 29, and any judge mandated edits are applied, (perhaps to the guidelines and rules) then we will begin the process of entering the final stages of the Great Fork Merge.

I'd guess the guidelines and rules indeed would be updated. As for the merge: I think you'll be away for a bit before it happens but before that you plan to freeze it so that no changes will be applied. Is this correct?

If you look the Great Fork Merge issue TODO list, you'll find an entry, just before the Great Fork Merge actually merges, that reads "Pause and ask for a review of readiness".

Our plan is to reach that point before we go "off the Internet" due to our expedition. Our being off the Internet for two weeks is that pause. The "Pause and ask for a review of readiness" will be about a 2 week pause.

Then sometime after 2024 November 15, when we come back online, will look at any potential PRs for this repo and the "other repo" and process them accordingly before doing the actual Great Fork Merge.

Now this 2 week pause is not a license to do all kinds of minor content tweaks, it's more for things like "you forgot to change this reference to the new web site" kind of stuff.

OK if there is a seriously wrong such as "the wrong author is mentioned in an entry", or perhaps "the wrong file is linked", or something else at that level (we don't think we have any such issues today, but you never know) then that we can such a fix slide in at that time. Do try, however, to limit such fixed to only very serious and significant problems that need to be corrected). This also goes for the "other repo".

So between now and "last call" feel free to do random spot checks and make minor changes while issue #2006 is open.

@lcn2
Copy link
Author

lcn2 commented Oct 23, 2024

As for the todo list in this issue: there is unfortunately no way I can possible do all of those before the 28th. The checking for the lint would itself take a lot of time and I think the FAQ is more important? But on that note the FAQ itself is very large and to go over it thoroughly (as a toad item says) will take much time. I'm not sure if I can simplify the whole thing much more but I will check that links are good and that the linter has no complaints.

I'm going to look at the FAQ first two or three sections in a short bit but I wanted to reply to this as you requested.

The final touchups and random inspections before "last call" is of higher priority.

During the two week pause while we are off the Internet you could look at what we've done with the two that have been performed and issue PR's to correct any mistakes you might find.

In summary: rather than reviewing the TODOs, when we enter our two week pause review the results of the TODDs that have been performed. We suggest you do this starting in November and prior to 2024 November 15. This way you can focus on the "last call" before issues close.

@xexyl
Copy link

xexyl commented Oct 23, 2024

Once the IOCCC Judges meet on 2024, October 29, and any judge mandated edits are applied, (perhaps to the guidelines and rules) then we will begin the process of entering the final stages of the Great Fork Merge.

I'd guess the guidelines and rules indeed would be updated. As for the merge: I think you'll be away for a bit before it happens but before that you plan to freeze it so that no changes will be applied. Is this correct?

If you look the Great Fork Merge issue TODO list, you'll find an entry, just before the Great Fork Merge actually merges, that reads "Pause and ask for a review of readiness".

Thanks. I went over it very quickly with bleary eyes.

Our plan is to reach that point before we go "off the Internet" due to our expedition. Our being off the Internet for two weeks is that pause. The "Pause and ask for a review of readiness" will be about a 2 week pause.

I think that on my behalf I should be able to - or mostly.

Then sometime after 2024 November 15, when we come back online, will look at any potential PRs for this repo and the "other repo" and process them accordingly before doing the actual Great Fork Merge.

Sounds good. Though I can't imagine anything else in the other repo: unless for instance a bug in jparse (a tool) is fixed or another bug found in mkiocccentry is fixed, of course.

Now this 2 week pause is not a license to do all kinds of minor content tweaks, it's more for things like "you forgot to change this reference to the new web site" kind of stuff.

Of course. It's more of a check on things. I understand.

OK if there is a seriously wrong such as "the wrong author is mentioned in an entry", or perhaps "the wrong file is linked", or something else at that level (we don't think we have any such issues today, but you never know) then that we can such a fix slide in at that time. Do try, however, to limit such fixed to only very serious and significant problems that need to be corrected). This also goes for the "other repo".

Of course. As above.

So between now and "last call" feel free to do random spot checks and make minor changes while issue #2006 is open.

Okay so the last call is before you leave and then when you return you can address anything? I just want to make sure I have that right. I am having a hard time seeing right now but I did start (again) working on the FAQ. I will take a short break and continue.

As or #2006: when do you plan on closing it? I do not believe anything else has to be done but it's possible something will come up.

In any case the fact there is a bit more time is helpful. I do not know if I can get through all of it but I can certainly get through more!

Thanks and please clarify the part about the 'last call': is that when you're gone as in right before you leave?

@xexyl
Copy link

xexyl commented Oct 23, 2024

As for the todo list in this issue: there is unfortunately no way I can possible do all of those before the 28th. The checking for the lint would itself take a lot of time and I think the FAQ is more important? But on that note the FAQ itself is very large and to go over it thoroughly (as a toad item says) will take much time. I'm not sure if I can simplify the whole thing much more but I will check that links are good and that the linter has no complaints.
I'm going to look at the FAQ first two or three sections in a short bit but I wanted to reply to this as you requested.

The final touchups and random inspections before "last call" is of higher priority.

Again once I know which part is the last call I can be of better help.

During the two week pause while we are off the Internet you could look at what we've done with the two that have been performed and issue PR's to correct any mistakes you might find.

That sounds good. That makes me think that the last call is before you leave. Is that correct?

In summary: rather than reviewing the TODOs, when we enter our two week pause review the results of the TODDs that have been performed. We suggest you do this starting in November and prior to 2024 November 15. This way you can focus on the "last call" before issues close.

Okay so don't focus on what might have to be done but instead what has been done?

Thanks. I can start in early November sure. Or maybe even before it.

@lcn2
Copy link
Author

lcn2 commented Oct 23, 2024

We do recommend you do see the new heading of "FINAL REVIEW" to better understand what might happen between the:

"last call and IOCCC Judges formal review, and when we go off-line"

And when we return sometime around 2025 November 15.

Our hope is to before we go off-line, to reach the "FINAL REVIEW" stage and then pause for two weeks.

@xexyl
Copy link

xexyl commented Oct 23, 2024

We do recommend you do see the new heading of "FINAL REVIEW" to better understand what might happen between the:

"last call and IOCCC Judges formal review, and when we go off-line"

And when we return sometime around 2025 November 15.

Our hope is to before we go off-line, to reach the "FINAL REVIEW" stage and then pause for two weeks.

I looked at it but I'm afraid that right now i'm too tired to parse it properly :( So with that said I'll look at the FAQ and then I'll try and look at it in a while. If I get the how to enter sections checked out then I guess the rest can be checked during the fortnight or so that you are gone (though hopefully I can actually do some of that before you leave).

@lcn2
Copy link
Author

lcn2 commented Oct 23, 2024

I looked at it but I'm afraid that right now i'm too tired to parse it properly :( So with that said I'll look at the FAQ and then I'll try and look at it in a while. If I get the how to enter sections checked out then I guess the rest can be checked during the fortnight or so that you are gone (though hopefully I can actually do some of that before you leave).

Don't worry about not reviewing the TODO list. As we said, we are reasonably confident it is the right thing to do.

Focus now on the random "spot checks" as part of the "last call" before the issues close.

Then, during first half of November (when we reach the "FINAL REVIEW" TODO stage) spend that time looking at the result of the actions that have been done and issue PR's accordingly.

@xexyl
Copy link

xexyl commented Oct 23, 2024

I looked at it but I'm afraid that right now i'm too tired to parse it properly :( So with that said I'll look at the FAQ and then I'll try and look at it in a while. If I get the how to enter sections checked out then I guess the rest can be checked during the fortnight or so that you are gone (though hopefully I can actually do some of that before you leave).

Don't worry about not reviewing the TODO list. As we said, we are reasonably confident it is the right thing to do.

Focus now on the random "spot checks" as part of the "last call" before the issues close.

In other words the FAQ and things like that, right?

Then, during first half of November (when we reach the "FINAL REVIEW" TODO stage) spend that time looking at the result of the actions that have been done and issue PR's accordingly.

Thanks.

@lcn2
Copy link
Author

lcn2 commented Oct 23, 2024

In other words the FAQ and things like that, right?

Yes, moreover we would pick entries at random and look at spots inside them just as a way to look over random things a part the "last call" and before the issues close. You can do this as you have time between now and when the issues close.

Sometimes looking at a large work at random spots rather than chronologically, as you've done before, will reveal things.

We believe that both issues are in good shape and could technically close now. But since the issues won't close until 2024 October 27, this "last call " period is a good time to jump around and to look at random things and tweak anything that may come to mind.

We hope this clarifies.

@xexyl
Copy link

xexyl commented Oct 23, 2024

In other words the FAQ and things like that, right?

Yes, moreover I would pick entries at random and look at spots inside them just as a way to look over random things a part the "last call" and before the issues close. You can do this as you have time between now and when the issues close.

Thanks.

Sometimes looking at a large work at random spots rather than chronologically, as you've done before, will reveal things.

I can see that happening sometimes, yes. I'll try this.

We believe that both issues are in good shape and could technically close now. But since the issues won't close until 2024 October 27, this "last call " period is a good time to jump around and to look at random things and tweak anything that may come to mind.

Okay that's great to know. It'll also make it a bit easier. Does this apply to the how to enter and related sections? If I could know this it would help simplify making any last minute changes and maybe I could look at random entries instead.

QUESTION

What do you think about those few sections? Are they also in a state that I needn't worry about it so much?

We hope this clarifies.

It certainly does! Thanks!

@lcn2
Copy link
Author

lcn2 commented Oct 23, 2024

What do you think about those few sections? Are they also in a state that I needn't worry about it so much?

We believe they're in generally good shape.

As we said before technically the issues could close now, but we might as well leave them open until 2024 October 27 and use this "last call" time period to do random spot checks of stuff in the repo.

@lcn2
Copy link
Author

lcn2 commented Oct 23, 2024

Apple's speech to text on an iPhone really does not like to translate 1st person plural 🤓.

@lcn2
Copy link
Author

lcn2 commented Oct 23, 2024

This "last call", like a large software project that is just short of a formal release. It is past QA. And only final touchups and polishing should be done.

Developers should use this time to do random spot checks. They must to not do any major new initiatives nor huge code changes. Random spot checks, including looking at code comments, are more of the order of the day.

@xexyl
Copy link

xexyl commented Oct 23, 2024

Apple's speech to text on an iPhone really does not like to translate 1st person plural 🤓.

Don't get me started on the iOS or even macOS bugs in the past year! Photos in macOS is so bad it's almost impossible to use without wanting to throw the laptop out of the window. Captions disappearing for one terrible example. And iOS - one of the most annoying one is the preview of mail now shows the original mail. But others are really awful too.

But I'm not surprised speech to text is bad. Siri is terrible at picking things up. The amount of things she has heard is a huge number. Some are hilarious but most are just idiotic. One thing that always gets worse is Siri. I Siriously doubt that the so-called Apple Intelligence will help there. Even if she somehow becomes 'smarter' the fact that she hears things wrong at least 75% of the time (in many people's experience) means she won't be able to do the right thing.

@xexyl
Copy link

xexyl commented Oct 23, 2024

This "last call", like a large software project that is just short of a formal release. It is past QA. And only final touchups and polishing should be done.

Developers should use this time to do random spot checks. They must to not do any major new initiatives nor huge code changes. Random spot checks, including looking at code comments, are more of the order of the day.

That's a lot better for me too. Thanks!

@lcn2
Copy link
Author

lcn2 commented Oct 27, 2024

MOVING FORWARD

We have replaced these TODO items:

  • Integrate screenshots for the registration process into the FAQ

  • Integrate screenshots for the submission process into the FAQ

With these TODO items:

  • Create an initial text for details of the registration process as a new FAQ 1.4

  • reate an initial text for details of the submit process as a new FAQ 1.5

These two TODO items focus on FAQ 0.0 subsection 2 "Register for the IOCCC" and subsection 5 "Upload your entry to the IOCCC submit server". Given the time we have left before we leave the continent, it may be better for us to put in some description text into those sub-sections without images before we leave.

To keep the text of FAQ 0.0 short, we plan to add an FAQ 1.4 and FAQ 1.5 where the more details will be found. The FAQ 0.0 subsections 2 and 5 will have a "see also" to their respective to FAQ 1.4 and FAQ 1.5 entries. Before we go, we will try to create placeholder FAQ 1.4 and FAQ 1.5 where some form of "watch this space for screenshots and additional details" will be put. This way, even if the Registration process and Submit server are not ready by the time the Great Fork Merge is complete, the FAQs related to recitation and submitting will look coherent.

Obviously these MUST be ready by the time IOCCC28 turns in to a PENDING state. We are confident that our resignation and submit server architecture and design will work. We simply need to be realistic about completing the resignation and submit server prior to going offline (it almost certainly won't be ready by 2024 October 29), and perhaps prior to the Great Fork Merge completing (that might not happen by the time the the Official IOCCC winner repo and the Official IOCCC web site are updated either).

So this is our plan to not let our travels and the Great Fork Merge be stalled for these issues.

UPDATE 0

The TODO items above have been changed.

@xexyl
Copy link

xexyl commented Oct 28, 2024

MOVING FORWARD

We have replaced these TODO items:

  • Integrate screenshots for the registration process into the FAQ
  • Integrate screenshots for the submission process into the FAQ

With these TODO items:

  • Create an initial text for details of the registration process as a new FAQ 1.4
  • reate an initial text for details of the submit process as a new FAQ 1.5

These two TODO items focus on FAQ 0.0 subsection 2 "Register for the IOCCC" and subsection 5 "Upload your entry to the IOCCC submit server". Given the time we have left before we leave the continent, it may be better for us to put in some description text into those sub-sections without images before we leave.

To keep the text of FAQ 0.0 short, we plan to add an FAQ 1.4 and FAQ 1.5 where the more details will be found. The FAQ 0.0 subsections 2 and 5 will have a "see also" to their respective to FAQ 1.4 and FAQ 1.5 entries. Before we go, we will try to create placeholder FAQ 1.4 and FAQ 1.5 where some form of "watch this space for screenshots and additional details" will be put. This way, even if the Registration process and Submit server are not ready by the time the Great Fork Merge is complete, the FAQs related to recitation and submitting will look coherent.

Obviously these MUST be ready by the time IOCCC28 turns in to a PENDING state. We are confident that our resignation and submit server architecture and design will work. We simply need to be realistic about completing the resignation and submit server prior to going offline (it almost certainly won't be ready by 2024 October 29), and perhaps prior to the Great Fork Merge completing (that might not happen by the time the the Official IOCCC winner repo and the Official IOCCC web site are updated either).

So this is our plan to not let our travels and the Great Fork Merge be stalled for these issues.

UPDATE 0

The TODO items above have been changed.

Thanks for the update! Is there anything I can do to help here? Also when do you wish me to start looking over things at random?

And in case I don't get a chance: SAFE AND FUN travels (and time)!

@xexyl
Copy link

xexyl commented Oct 28, 2024

Did I reply to everything btw?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request top priority This a top priory critical path issue for next milestone
Projects
None yet
Development

No branches or pull requests

3 participants