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

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

Open
izwicky opened this issue Feb 7, 2024 · 2 comments
Labels
no-issue-activity Discuss has gone quiet. Auto-tagging to encourage people to re-engage with the issue (or close it!).

Comments

@izwicky
Copy link

izwicky commented Feb 7, 2024

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.

@danbri
Copy link
Contributor

danbri commented Feb 12, 2024

@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.

Copy link

This issue is being nudged due to inactivity.

@github-actions github-actions bot added the no-issue-activity Discuss has gone quiet. Auto-tagging to encourage people to re-engage with the issue (or close it!). label May 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-issue-activity Discuss has gone quiet. Auto-tagging to encourage people to re-engage with the issue (or close it!).
Projects
None yet
Development

No branches or pull requests

2 participants