Skip to content

Fix dead links and anchors in the documentation - #826

Open
chenyangsu wants to merge 1 commit into
OHDSI:mainfrom
chenyangsu:fix/docs-broken-links
Open

chenyangsu wants to merge 1 commit into
OHDSI:mainfrom
chenyangsu:fix/docs-broken-links

Conversation

@chenyangsu

Copy link
Copy Markdown

Some links on the site either 404 or open the right page at the top instead of the right section.

404s (targets moved)

Source Was Now
site/faq.qmd tree/master/CodeExcerpts/DerivedTables sqlScripts.html#era-tables
site/indices-primary-foreign.qmd tree/v5.4/inst/csv tree/main/inst/csv
site/indices-primary-foreign.qmd blob/v5.4/ddl/5.4/redshift/…_ddl.sql blob/main/inst/ddl/5.4/redshift/…_ddl.sql
site/cdm54erd.qmd raw/main/rmd/images/erd.jpg raw/main/site/man/images/erd.jpg

Anchors broken by the Quarto migration. Quarto ids are lowercase and use hyphens, so these fragments no longer match (same kind of fix as #810):

  • sqlScripts.html#drug_eras and #condition_eras, from the DRUG_ERA and CONDITION_ERA table descriptions in the v5.3, v5.4 and v5.5 Table_Level CSVs. Also #Source_to_Standard in customConcepts.qmd.
  • dataModelConventions.html#concept_relationships, from the v5.3, v5.4 and v5.5 Field_Level CSVs.
  • cdm54.html#CONDITION_ERA, #DRUG_EXPOSURE and similar in faq.qmd. One was also misspelled, #CONDITION_OCCURENCE. Also #Standardized-Vocabularies → #vocabulary-tables.
  • cdm531.html#death, #payer_plan_period, #condition_era and #observation (v5.3 Table_Level CSV and cdm60.qmd). cdm531.html is now a stub that points to cdm53.html, where those sections exist.

Check: after the change, every ohdsi.github.io/CommonDataModel/…#anchor link in site/*.qmd and the v5.3, v5.4 and v5.5 CSVs matches an id in the rendered docs/ page. The three new GitHub URLs return 200.

I re-rendered the eight affected pages and kept only the link hunks in docs/, because my local Quarto is 1.10.20, not 1.10.18. This branch and #825 merge cleanly in either order.

Four links return 404 because their targets moved:
- faq.qmd: CodeExcerpts/DerivedTables was removed; the era scripts now live
  on the SQL Scripts page (sqlScripts.html#era-tables).
- indices-primary-foreign.qmd: there is no v5.4 branch or tag; point the CSV
  and Redshift DDL links at main/inst/.
- cdm54erd.qmd: the printable ERD moved from rmd/images to site/man/images.

The Quarto migration changed heading anchors to lowercase, hyphenated ids,
so these links open the right page but not the right section:
- sqlScripts.html#drug_eras / #condition_eras (DRUG_ERA and CONDITION_ERA
  table descriptions, v5.3-v5.5) and #Source_to_Standard.
- dataModelConventions.html#concept_relationships (v5.3-v5.5 field specs).
- cdm54.html#CONDITION_ERA etc. in the FAQ (upper case; one also misspelled
  CONDITION_OCCURENCE) and #Standardized-Vocabularies -> #vocabulary-tables.
- cdm531.html is now a stub that points to cdm53.html, so its #death,
  #payer_plan_period, #condition_era and #observation anchors moved there.

Re-rendered the affected pages and kept only the link changes in docs/.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant