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

Use internal links for new index page #1495

Merged
merged 1 commit into from
Jun 4, 2024
Merged

Conversation

Eric-Arellano
Copy link
Collaborator

We shouldn't be using external links in general.

This PR also updates to use the new guides/ URLs. Note that we have some risk that the links we hardcode here diverge from our source of truth in entries.py. We can't have page_content.py load the final URLs from entries.py because it would result in a circular import. However, our link checker will complain if there are any divergences, so it should be fine.

@Eric-Arellano Eric-Arellano requested a review from arnaucasau June 4, 2024 17:24
Copy link
Collaborator

@arnaucasau arnaucasau left a comment

Choose a reason for hiding this comment

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

Thank you Eric!

@Eric-Arellano Eric-Arellano added this pull request to the merge queue Jun 4, 2024
Merged via the queue into main with commit 7d3ffdf Jun 4, 2024
2 checks passed
@Eric-Arellano Eric-Arellano deleted the EA/internal-links branch June 4, 2024 17:34
frankharkins pushed a commit to frankharkins/documentation that referenced this pull request Jul 22, 2024
We shouldn't be using external links in general.

This PR also updates to use the new `guides/` URLs. Note that we have
some risk that the links we hardcode here diverge from our source of
truth in `entries.py`. We can't have `page_content.py` load the final
URLs from `entries.py` because it would result in a circular import.
However, our link checker will complain if there are any divergences, so
it should be fine.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants