Glossary generator with apa lookup by kaysiz · Pull Request #595 · forrtproject/forrtproject.github.io

kaysiz · 2026-01-26T08:56:03Z

Description

Adds an APA-reference lookup workflow and updates glossary generation to use it when producing glossary entry files.

Changes:

Added content/glossary/apa_lookup.json as a citation-key → APA-formatted reference lookup.
Refactored content/glossary/_create_glossaries.py to pull glossary data from a Google Sheets CSV export and format references via the APA lookup.
Added a Node.js utility (bibtex_to_apa/) and CI workflow steps to generate/update the APA lookup during data processing.

Expected behavior:

Glossary entries now show APA-formatted references (from the lookup) instead of raw citation keys.
The language switcher on glossary pages should correctly link to the same entry in other available languages.

@kaysiz you can add more informations that I might have missed about this PR

Type of Change

Documentation/Contents/grammar update
New feature (non-breaking change which adds functionality)
Bug fix (non-breaking change which fixes an issue)

How Has This Been Tested?

Tested Locally
Manual review / previewed on staging.forrt.org

Checklist for Content Editors and Non-Developers

Checklist for Developers:

I have attempted to stay aligned to related code in this repository rather than reinventing the wheel.
I have performed a self-review of my own code.
I have commented my code, particularly in hard-to-understand areas.
I have made corresponding changes to the documentation.
My changes generate no new warnings.

Additional Notes

github-actions · 2026-01-26T08:56:23Z

✅ Spell Check Passed

No spelling issues found in this PR! 🎉

github-actions · 2026-01-26T08:56:29Z

👍 All image files/references (if any) are in webp format, in line with our policy.

github-actions · 2026-01-27T12:31:28Z

✅ Spell Check Passed

No spelling issues found in this PR! 🎉

Copilot

Pull request overview

Adds an APA-reference lookup workflow and updates glossary generation to use it when producing glossary entry files.

Changes:

Added content/glossary/apa_lookup.json as a citation-key → APA-formatted reference lookup.
Refactored content/glossary/_create_glossaries.py to pull glossary data from a Google Sheets CSV export and format references via the APA lookup.
Added a Node.js utility (bibtex_to_apa/) and CI workflow steps to generate/update the APA lookup during data processing.

Reviewed changes

Copilot reviewed 4 out of 6 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
content/glossary/apa_lookup.json	New citation-key → APA reference mapping used during glossary generation.
content/glossary/_create_glossaries.py	New glossary generation pipeline that reads a sheet export and formats references using the APA lookup.
bibtex_to_apa/package.json	Adds dependencies for converting BibTeX to APA via citation-js.
bibtex_to_apa/package-lock.json	Lockfile for the bibtex→APA conversion tool dependencies.
bibtex_to_apa/bibtex_to_apa.js	Node script to fetch BibTeX and emit `apa_lookup.json`.
.github/workflows/data-processing.yml	Installs Node deps and runs the bibtex→APA generation step in CI.

Files not reviewed (1)

bibtex_to_apa/package-lock.json: Language not supported

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

bibtex_to_apa/bibtex_to_apa.js

content/glossary/_create_glossaries.py

.github/workflows/data-processing.yml

content/glossary/_create_glossaries.py

…ect/forrtproject.github.io into ks-refactor-glossary-generator

github-actions · 2026-01-29T13:32:45Z

✅ Spell Check Passed

No spelling issues found in this PR! 🎉

github-actions · 2026-01-29T13:32:57Z

✅ Spell Check Passed

No spelling issues found in this PR! 🎉

github-actions · 2026-02-05T04:59:14Z

✅ Spell Check Passed

No spelling issues found in this PR! 🎉

github-actions · 2026-02-05T15:05:06Z

✅ Spell Check Passed

No spelling issues found in this PR! 🎉

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

github-actions · 2026-02-10T19:37:07Z

✅ Spell Check Passed

No spelling issues found in this PR! 🎉

github-actions · 2026-02-10T19:48:19Z

✅ Spell Check Passed

No spelling issues found in this PR! 🎉

github-actions · 2026-02-11T16:30:01Z

✅ Spell Check Passed

No spelling issues found in this PR! 🎉

LukasWallrich · 2026-02-11T16:46:37Z

@copilot the references generated by this PR look like the attached. Can you help figure out what is wrong?

Copilot · 2026-02-11T16:46:46Z

@LukasWallrich I've opened a new pull request, #639, to work on those changes. Once the pull request is ready, I'll request review from you.

github-actions · 2026-02-16T11:59:45Z

✅ Spell Check Passed

No spelling issues found in this PR! 🎉

Copilot

Pull request overview

Copilot reviewed 5 out of 8 changed files in this pull request and generated 16 comments.

Files not reviewed (1)

bibtex_to_apa/package-lock.json: Language not supported

Comments suppressed due to low confidence (1)

.github/workflows/data-processing.yml:205

The "Run Tenzing script" step appears in the wrong location in the workflow. It's placed after Node.js setup but the comment suggests it should be processing contributor data. The step also has malformed YAML - there's shell code (sed command and echo) directly under the env block instead of being in a separate run block. This will cause the workflow to fail.

      - name: Run Tenzing script
        continue-on-error: true  # Continue even if this step fails
        run: python3 scripts/forrt_contribs/tenzing.py
        env:
          GSHEET_CREDENTIALS: ${{ secrets.GSHEET_CREDENTIALS }}
          # Clean up HTML artifacts from index.md if any
          sed -i.bak -e '/^```{=html}$/d' -e '/^```$/d' content/contributor-analysis/index.md && rm content/contributor-analysis/index.md.bak

          echo "✅ Contributor analysis complete"

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

content/glossary/_create_glossaries.py

.github/workflows/data-processing.yml

content/glossary/_create_glossaries.py

bibtex_to_apa/bibtex_to_apa.js

content/glossary/_create_glossaries.py

bibtex_to_apa/package.json

content/glossary/_create_glossaries.py

layouts/glossary/single.html

content/glossary/_create_glossaries.py

bibtex_to_apa/bibtex_to_apa.js

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

github-actions · 2026-02-16T12:08:21Z

✅ Spell Check Passed

No spelling issues found in this PR! 🎉

richarddushime

LGTM 💯

but I have minor comments

Suggestions :

References to be visually separated for clarity and readability.

Instead of displaying all APA-formatted references in a single comma-separated line, please use line breaks or bullet points to separate each reference. This will make the “References” section much easier to read and more consistent with APA style.

Example formatting:

Brown, N., Thompson, P., & Leigh, J. S. (2018)...
Pollet, I. L., & Bond, A. L. (2021)...
Suber, P. (2004)...
Pownall, M., Talbot, C. V., ... (2021)...

Or use <ul>/<li> for HTML, or <br> for line breaks.

github-actions · 2026-02-16T16:35:45Z

✅ Spell Check Passed

No spelling issues found in this PR! 🎉

kaysiz · 2026-02-16T16:37:56Z

LGTM 💯

but I have minor comments

Suggestions :

References to be visually separated for clarity and readability.

Instead of displaying all APA-formatted references in a single comma-separated line, please use line breaks or bullet points to separate each reference. This will make the “References” section much easier to read and more consistent with APA style.

Example formatting:

Brown, N., Thompson, P., & Leigh, J. S. (2018)...

Pollet, I. L., & Bond, A. L. (2021)...

Suber, P. (2004)...

Pownall, M., Talbot, C. V., ... (2021)...

Or use <ul>/<li> for HTML, or <br> for line breaks.

@richarddushime I have updated the PR, looks better now, thank you for the suggestion.

richarddushime · 2026-02-16T17:36:46Z

LGTM 🥇
All Good
tagging @LukasWallrich @flavioazevedo

github-actions · 2026-02-16T18:21:36Z

✅ Spell Check Passed

No spelling issues found in this PR! 🎉

flavioazevedo · 2026-02-16T20:16:34Z

It says all comments must be resolved before merging (which I cannot do)

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

github-actions · 2026-02-16T20:30:49Z

✅ Spell Check Passed

No spelling issues found in this PR! 🎉

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

github-actions · 2026-02-16T20:32:12Z

✅ Spell Check Passed

No spelling issues found in this PR! 🎉

LukasWallrich

Looks good - thanks so much @kaysiz!

kaysiz added 4 commits January 25, 2026 22:21

Add bibtex apa json generator

f6757ef

Initial apa look up file

df39d64

refactor translation markdown generation code

f3eb0a5

update workflow to add new flow to generate glossary

6f711b3

github-actions bot added content related Relevant to website content cicd Relevant to GitHub workflows labels Jan 26, 2026

kaysiz requested a review from LukasWallrich January 27, 2026 08:47

kaysiz self-assigned this Jan 27, 2026

Merge branch 'master' into ks-refactor-glossary-generator

266adb2

LukasWallrich requested a review from Copilot January 28, 2026 22:05

Copilot started reviewing on behalf of LukasWallrich January 28, 2026 22:05 View session

Copilot AI reviewed Jan 28, 2026

View reviewed changes

kaysiz and others added 4 commits January 29, 2026 14:25

Address review comments

5c291b3

Update gitignore

dc80c3c

Merge branch 'ks-refactor-glossary-generator' of github.com:forrtproj…

43aef0c

…ect/forrtproject.github.io into ks-refactor-glossary-generator

Merge branch 'master' into ks-refactor-glossary-generator

90edaf1

Implement missing reference tracking

fded9da

Merge branch 'master' into ks-refactor-glossary-generator

a5a4029

kaysiz and others added 2 commits February 10, 2026 20:36

Update .github/workflows/data-processing.yml

53bade3

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Merge branch 'master' into ks-refactor-glossary-generator

a1c329c

kaysiz marked this pull request as ready for review February 10, 2026 19:36

kaysiz requested a review from a team as a code owner February 10, 2026 19:36

Merge branch 'master' into ks-refactor-glossary-generator

4c691a4

Copilot AI mentioned this pull request Feb 11, 2026

Fix glossary references displaying as ASCII codes instead of formatted text #639

Draft

kaysiz and others added 2 commits February 16, 2026 13:58

fix references and associated languages

ca7349a

Merge branch 'master' into ks-refactor-glossary-generator

4e0fe79

kaysiz requested a review from Copilot February 16, 2026 11:59

Copilot started reviewing on behalf of kaysiz February 16, 2026 12:00 View session

Copilot AI reviewed Feb 16, 2026

View reviewed changes

Update bibtex_to_apa/package.json

90cb63c

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

richarddushime reviewed Feb 16, 2026

View reviewed changes

display references as list

a0f1e5b

kaysiz requested a review from richarddushime February 16, 2026 16:36

fix merge error with workflow

1e81d6f

Update content/glossary/_create_glossaries.py

299d50f

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update bibtex_to_apa/bibtex_to_apa.js

6345e14

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

LukasWallrich approved these changes Feb 17, 2026

View reviewed changes

LukasWallrich merged commit 3d20abb into master Feb 17, 2026
5 checks passed

LukasWallrich deleted the ks-refactor-glossary-generator branch February 17, 2026 12:11

Conversation

kaysiz commented Jan 26, 2026 • edited by richarddushime Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of Change

How Has This Been Tested?

Checklist for Content Editors and Non-Developers

Checklist for Developers:

Additional Notes

Uh oh!

github-actions bot commented Jan 26, 2026

✅ Spell Check Passed

Uh oh!

github-actions bot commented Jan 26, 2026

Uh oh!

github-actions bot commented Jan 27, 2026

✅ Spell Check Passed

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Jan 29, 2026

✅ Spell Check Passed

Uh oh!

github-actions bot commented Jan 29, 2026

✅ Spell Check Passed

Uh oh!

github-actions bot commented Feb 5, 2026

✅ Spell Check Passed

Uh oh!

github-actions bot commented Feb 5, 2026

✅ Spell Check Passed

Uh oh!

github-actions bot commented Feb 10, 2026

✅ Spell Check Passed

Uh oh!

github-actions bot commented Feb 10, 2026

✅ Spell Check Passed

Uh oh!

github-actions bot commented Feb 11, 2026

✅ Spell Check Passed

Uh oh!

LukasWallrich commented Feb 11, 2026

Uh oh!

Copilot AI commented Feb 11, 2026

Uh oh!

github-actions bot commented Feb 16, 2026

✅ Spell Check Passed

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Feb 16, 2026

✅ Spell Check Passed

Uh oh!

richarddushime left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Feb 16, 2026

✅ Spell Check Passed

Uh oh!

kaysiz commented Jan 26, 2026 •

edited by richarddushime

Loading

richarddushime left a comment •

edited

Loading