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

chore(docs): remove redirect to landing page & set latest alias to main #998

Merged
merged 3 commits into from
Dec 5, 2024

Conversation

danceratopz
Copy link
Member

@danceratopz danceratopz commented Dec 5, 2024

🗒️ Description

This PR makes two changes with regards to (unrelated) redirects:

  1. It removes this redirect to the online docs' landing page:
  2. "remove update of default doc version to latest tag". It stops updating the "latest" version of the docs the last pushed tag (in .github/workflows/docs_tags.yaml). E.g., the default version of the docs will no longer redirect to vX.Y.Z, e.g., this will not happen:
    uv run mike deploy --update-aliases --rebase --push --remote origin main latest
    

🔗 Related Issues

#929

✅ Checklist

  • All: Set appropriate labels for the changes.
  • All: Considered squashing commits to improve commit history.
  • All: Considered updating the online docs in the ./docs/ directory.
  • Tests: Ran mkdocs serve locally and verified the auto-generated docs for new tests in the Test Case Reference are correctly formatted.

@danceratopz danceratopz added scope:docs Scope: Documentation type:chore Type: Chore labels Dec 5, 2024
@danceratopz danceratopz self-assigned this Dec 5, 2024
@danceratopz danceratopz changed the title docs: remove ugly redirect to the main landing page chore(docs): remove ugly redirect to the main landing page Dec 5, 2024
Copy link
Collaborator

@spencer-tb spencer-tb left a comment

Choose a reason for hiding this comment

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

Thanks! LGTM

@spencer-tb
Copy link
Collaborator

I'm not sure how to but can we update the docs link on the EEST main page to point to:
https://ethereum.github.io/execution-spec-tests/main?

Currently its https://ethereum.github.io/execution-spec-tests/ which points to https://ethereum.github.io/execution-spec-tests/latest -> https://ethereum.github.io/execution-spec-tests/v3.0.0!

What do you think?

@danceratopz
Copy link
Member Author

I'm not sure how to but can we update the docs link on the EEST main page to point to: https://ethereum.github.io/execution-spec-tests/main?

Currently its https://ethereum.github.io/execution-spec-tests/ which points to https://ethereum.github.io/execution-spec-tests/latest -> https://ethereum.github.io/execution-spec-tests/v3.0.0!

What do you think?

Done in 6e341c9 - see description for details and the mike command 😆

The --rebase flag is important when a change has been made to the gh-pages branch to your local copy when running `mike deploy`.
@danceratopz danceratopz changed the title chore(docs): remove ugly redirect to the main landing page chore(docs): remove redirect to landing page & set latest alias to main Dec 5, 2024
@danceratopz danceratopz merged commit 7f01630 into main Dec 5, 2024
5 checks passed
@danceratopz danceratopz deleted the chore/docs/remove-redirect-to-getting-started branch December 5, 2024 15:27
codeofcarson pushed a commit to codeofcarson/execution-spec-tests that referenced this pull request Jan 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope:docs Scope: Documentation type:chore Type: Chore
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants