schemaorg icon indicating copy to clipboard operation
schemaorg copied to clipboard

Example IDs (data/ext/..) conflicts with new example IDs in data/examples.txt

Open izwicky opened this issue 1 year ago • 2 comments

What

The example IDs are globally registered, thus creating conflicts with newly added example IDs in data/examples.txt. This conflict makes the build fail and abort the process. Thus it's not possible to build.

Why

The data/examples.txt has a sequential ID structure and in order to keep it organized, all IDs need to be documented there and not spread out between data/examples.txt and the examples in data/ext/bib, data/ext/health-lifesci, etc.

Further, this doesn't make it easy to track the next ID to be used.

How

Possible solutions:

  • Update the example IDs to a number that's far from what's in production. Example: #eg-99999 Therefore, contributors can add IDs sequentially without interfering with the examples.
  • Not update the example IDs and continue the sequence from the last ID found in data/ext/bib, data/ext/health-lifesci, etc. -- This will break the sequence in data/examples.txt and make it harder to track IDs.

I can open a PR, but wanted to make sure that I'm not missing a detail or if there's a consensus to fix this.

izwicky avatar Feb 07 '24 16:02 izwicky

@RichardWallis can you comment?

My understanding was that ./software/util/buildsite.py --release ought to clean up IDs (adding where necessary at least) when building the site.

danbri avatar Feb 12 '24 17:02 danbri

This issue is being nudged due to inactivity.

github-actions[bot] avatar May 13 '24 02:05 github-actions[bot]