Skip to content

HDXDSYS-3035 Link to HDX core concepts in docs and rename API key page to API token - #133

Merged
mcarans merged 1 commit into
mainfrom
docs-api-token
Nov 17, 2026
Merged

mcarans merged 1 commit into
mainfrom
docs-api-token

Conversation

@mcarans

@mcarans mcarans commented Nov 17, 2026

Copy link
Copy Markdown
Contributor

Changes

  • Link to HDX core concepts from how-to/objects.md, explanation/information.md and the token page.
  • Replace the outdated website steps in the API key how-to with that link. The page keeps the library-specific options (hdx_key parameter, HDX_KEY environment variable, .hdx_configuration.yaml).
  • Rename how-to/api-key.md to how-to/api-token.md and update the nav, index and links. The page's published URL changes.
  • Use "API token" instead of "API key" in the docs, except the historical changelog entry.
  • Remove the .hdxkey references (explanation/facades.md, tutorials/getting-started.md); the code does not read that file.
  • Refresh uv.lock.

Testing

uv run pytest: 195 passed, 1 error (test_ckan.py::test_create_dataset, needs HDX_PIPELINE_GSHEET_AUTH, an integration test). Docs not built locally.

Replace the stale website steps in the API key how-to with a link to HDX core concepts, keeping the library-specific ways to supply the token. Rename the page to api-token.md, use 'API token' consistently and remove references to the unused .hdxkey file.
@mcarans mcarans changed the title Link to HDX core concepts in docs and rename API key page to API token HDXDSYS-3035 Link to HDX core concepts in docs and rename API key page to API token Nov 17, 2026
@github-actions

github-actions Bot commented Nov 17, 2026 •

Copy link
Copy Markdown

Test Results

196 tests  ±0   196 ✅ ±0   1m 21s ⏱️ +2s
  1 suites ±0     0 💤 ±0 
  1 files   ±0     0 ❌ ±0 

Results for commit 708ba24. ± Comparison against base commit b85fdbb.

♻️ This comment has been updated with latest results.

@coveralls

Copy link
Copy Markdown

Coverage Status

coverage: 97.405%. remained the same — docs-api-token into main

@mcarans
mcarans merged commit 8102ffa into main Nov 17, 2026
6 checks passed
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.

2 participants