Skip to content

Fix broken documentation links flagged by weekly link checker#4528

Open
Atishyy27 wants to merge 1 commit into
AI-Hypercomputer:mainfrom
Atishyy27:docs/fix-broken-doc-links
Open

Fix broken documentation links flagged by weekly link checker#4528
Atishyy27 wants to merge 1 commit into
AI-Hypercomputer:mainfrom
Atishyy27:docs/fix-broken-doc-links

Conversation

@Atishyy27

Copy link
Copy Markdown

Description

The weekly documentation link checker has been reporting the same two broken links for several consecutive runs (most recently #4440). This PR fixes both so the check passes.

  • docs/guides/monitoring_and_debugging/use_vertex_ai_tensorboard.md:31 — the "Vertex AI API" link (.../vertex-ai/docs/start/cloud-environment#set_up_a_project) is permanently redirected. Updated to the current URL (.../gemini-enterprise-agent-platform/machine-learning/start/cloud-environment#set_up_a_project), which returns 200 and still contains the #set_up_a_project anchor.
  • docs/guides/data_input_pipeline/data_input_grain.md:18 — the "shuffle seed" link pointed at grain.dataset.html#grain.MapDataset.shuffle; after Grain's documentation restructure that anchor no longer exists (the page's member list is now empty). Repointed to Grain's current dataset basics tutorial, which documents .shuffle(seed=...) and its determinism behavior — the most relevant live target.

FIXES: #4440

Tests

No code change. Both replacement URLs were verified manually with curl -L:

  • The Vertex AI target returns HTTP 200 and the page contains id="set_up_a_project".
  • The Grain tutorial target returns HTTP 200 and documents the shuffle-seed behavior referenced by the surrounding text.

Checklist

  • I have performed a self-review of my code.
  • I have necessary comments in my code, particularly in hard-to-understand areas.
  • I have run end-to-end tests tests and provided workload links above if applicable.
  • I have made or will make corresponding changes to the doc if needed.

The weekly documentation link checker (issue AI-Hypercomputer#4440 and prior runs) reported two
broken links:

- use_vertex_ai_tensorboard.md: the Vertex AI 'set up a project' link
  permanently redirects; point it at the current URL (verified 200, anchor
  #set_up_a_project present).
- data_input_grain.md: the grain.dataset.html#grain.MapDataset.shuffle anchor no
  longer exists after Grain's docs restructure; point the 'shuffle seed' link at
  the current Grain dataset tutorial, which documents .shuffle(seed=...).
@gemini-code-assist

Copy link
Copy Markdown

Caution

The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased.

@google-cla

google-cla Bot commented Jul 17, 2026

Copy link
Copy Markdown

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@aireenmei aireenmei left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the fix. Please sign CLA following the link in CLA bot message

@Atishyy27

Copy link
Copy Markdown
Author

signed the cla, the check is green now. thanks for the quick review @aireenmei 🙏

@Atishyy27
Atishyy27 requested a review from aireenmei July 17, 2026 23:56
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.

Documentation Link Check Failed - 2026-07-13

2 participants