Upgrade Website #3289
Closed
Upgrade Website #3289
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Allow this repo to use the same github actions as the origin. The scripts manually push changes to the `gh-pages` branch for website deployment so we need to update some references to do it safely
This fork doesn't have the correct secrets so I doubt it could actually update anything, but lets be safe and also save us some build failures
Deploy: Remove unsafe references to facebook/Ax
So that we don't have to create fake releases just to re-deploy the website while testing
Deploy: Allow triggering deploys manually
A more lightweight way to update the website while testing, skips automated testing
Don't need this in fork
Action: publish website
When using pinned botorch i keep getting the error ``` ModuleNotFoundError: No module named 'botorch.acquisition.multi_objective.base' ``` I see this happening on the main repo as well, working around it for now as this is the path used for nightly crons
…latest Actions: Publish website using latest BoTorch
efb4fc1 is missing these environment variables, without them we are seeing the same issue as before
…atest Actions: Publish website, actually use latest
We don't have docusaurus-bot in this repo so let's specify my user. I may need to add an auth token for myself if this fails. Also don't execute tutorials, it adds like 2 hours to the build time and is not necessary for this phase of testing.
Actions: Specify user for publishing website
Actions: Add github token for publishing website
…email Actions: Fix git user and email
The previous code attempted to create these same strings using the actions `github` environment variable but these are not available in the shell script. It may be possible to pass in the variable but we can just be explicit here instead that this is intended to be done by the bot. The name and email are provided by the official actions/checkout@v4 documentation: https://github.com/actions/checkout?tab=readme-ov-file#push-a-commit-using-the-built-in-token
…ctions-bot Actions: Publish Website use github actions bot
Also temporarily disable google analytics and algolia
These don't need to be configured when deploying from a local machine
This is the result of running ``` npx @docusaurus/migrate migrate website website-v2 ``` There are further automated scripts to assist with migrating individual pages, and manual steps will also be necessary. The website will not properly load yet, this commit is mostly to more easily compare the diffs between steps.
followup to 62caa56
This was incorrectly migrated. We will manually migrate our CSS in a later step
This was added as a demonstration of the feature, we can consider adding this feature back in the future.
These were disabled to speed up testing during development. Re-enabling now in preparation for opening pull request.
This script was simplified in the botorch repo, we want to keep the setups as similar as possible between the two repos so we duplicate the changes here. We can consider truly sharing this part of the setup in the future by making this script a shared Github Action.
This was introduced for testing purposed. We can still manually trigger the workflows from the github UI
sphinx-rtd-theme v3.0.0 supports sphinx v8
…rsion changes not for patch releases.
We were keeping this around as a convenient reference during the upgrade, no longer necessary.
Reverting these files back to their upstream versions after bad merge.
There are some changes to the tutorials in upstream. Since we moved the files around we can't just resolve merge conflicts. Instead let's just overwrite with the latest, this has the benefit of wiping the data from running the tutorials locally from testing. In the next commit I'll add the code cells again to support google. colab
duplicate of fa2a2e8 after catching up with latest origin
Org and website references should point to the official names and links. Further preparation for merging back into upstream. There's a lingering reference in the algolia setup but we'll update that separately
Preparation for merge into upstream
Still missing appId, will add that once I have access
facebook-github-bot
added
the
CLA Signed
The fork was hosted at /Ax/ but the official website does not use a baseUrl
|
@CristianLara has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator. |
|
@CristianLara has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3289 +/- ##
=======================================
Coverage 96.01% 96.01%
=======================================
Files 518 518
Lines 52132 52132
=======================================
Hits 50057 50057
Misses 2075 2075 ☔ View full report in Codecov by Sentry. |
CristianLara
added a commit
to CristianLara/Ax
that referenced
this pull request
Jan 31, 2025
Summary: ## Context This is the Ax counterpart to the same upgrade in Botorch: pytorch/botorch#2653 ## Motivation We are already using most of the correct tooling but it has become very out of date and is tied together with scripts that are difficult to maintain. Upgrade our tooling by updating to latest versions and dramatically simplifying our setup/deploy scripts. Includes: - Upgrade Docusaurus from V1 to V3 - Utilize new MDX support in Docusaurus by converting our tutorials to MDX (previously converted to html) - Tutorials link to Colab for easy execution - Website versioning is now handled natively through Docusaurus - New website versions are only created for major and minor releases (not patches) - Build and Deploy workflows have been dramatically simplified - Change Sphinx theme to ReadTheDocs - API Reference is still built using Sphinx but is now hosted by ReadTheDocs. ReadTheDocs also handles versioning. - Legacy website will be frozen and available at [archive.ax.dev](archive.ax.dev) - Served by Vercel from the `archive` branch - Website now supports dark mode | Before | After | | -------- | ------- | | <img width="1325" alt="image" src="https://github.com/user-attachments/assets/4af73120-f125-47e2-8285-bd01f4251ee9" /> | <img width="1330" alt="image" src="https://github.com/user-attachments/assets/ea17c47c-5012-47ab-a9d2-4b7e9c103cb0" /> | | <img width="1328" alt="image" src="https://github.com/user-attachments/assets/3dbde70a-8b84-43a4-8374-362f594de7fc" /> | <img width="1332" alt="image" src="https://github.com/user-attachments/assets/c779b7dd-76b9-4eb3-9b08-ca663732d7ec" /> | | <img width="1328" alt="image" src="https://github.com/user-attachments/assets/25d74ed7-4536-43a3-8654-ed291ae50cf3" /> | <img width="1331" alt="image" src="https://github.com/user-attachments/assets/e2438746-d975-4a09-96b5-d73e5d1a9980" /> | | <img width="1327" alt="image" src="https://github.com/user-attachments/assets/bcf71617-a537-45e4-a5e8-452de946a238" /> | <img width="1277" alt="image" src="https://github.com/user-attachments/assets/71b34ff9-1aaf-4c39-ade1-7bb346aad317" /> | ## Considerations - Our tutorials are natively embedded and versioned in the website using Docusaurus, but our sphinx-generated API reference is not. ReadTheDocs will create new version of the sphinx docs for every new release tag in our github repo. - Continue using same integrations for Algolia Search and Google Analytics - The number and type of github workflows we have remain the same, but the complexity of the workflows and the supporting scripts has been simplified. Pull Request resolved: facebook#3289 Test Plan: - I've enabled all the workflows in my PR and everything is passing [https://github.com/CristianLara/botorch/actions](https://github.com/CristianLara/botorch/actions) - Pypy deploy and codecov are failing as expected due to missing credentials - Website for my fork is being actively built and served at [cristianlara.me/Ax](cristianlara.me/Ax) - API Reference is being built and served by ReadTheDocs at [https://ax.readthedocs.io/](https://ax.readthedocs.io/) Differential Revision: D68916590 Pulled By: CristianLara
CristianLara
added a commit
to CristianLara/Ax
that referenced
this pull request
Jan 31, 2025
Summary: Pull Request resolved: facebook#3294 ## Context This is the Ax counterpart to the same upgrade in Botorch: pytorch/botorch#2653 ## Motivation We are already using most of the correct tooling but it has become very out of date and is tied together with scripts that are difficult to maintain. Upgrade our tooling by updating to latest versions and dramatically simplifying our setup/deploy scripts. Includes: - Upgrade Docusaurus from V1 to V3 - Utilize new MDX support in Docusaurus by converting our tutorials to MDX (previously converted to html) - Tutorials link to Colab for easy execution - Website versioning is now handled natively through Docusaurus - New website versions are only created for major and minor releases (not patches) - Build and Deploy workflows have been dramatically simplified - Change Sphinx theme to ReadTheDocs - API Reference is still built using Sphinx but is now hosted by ReadTheDocs. ReadTheDocs also handles versioning. - Legacy website will be frozen and available at [archive.ax.dev](archive.ax.dev) - Served by Vercel from the `archive` branch - Website now supports dark mode | Before | After | | -------- | ------- | | <img width="1325" alt="image" src="https://github.com/user-attachments/assets/4af73120-f125-47e2-8285-bd01f4251ee9" /> | <img width="1330" alt="image" src="https://github.com/user-attachments/assets/ea17c47c-5012-47ab-a9d2-4b7e9c103cb0" /> | | <img width="1328" alt="image" src="https://github.com/user-attachments/assets/3dbde70a-8b84-43a4-8374-362f594de7fc" /> | <img width="1332" alt="image" src="https://github.com/user-attachments/assets/c779b7dd-76b9-4eb3-9b08-ca663732d7ec" /> | | <img width="1328" alt="image" src="https://github.com/user-attachments/assets/25d74ed7-4536-43a3-8654-ed291ae50cf3" /> | <img width="1331" alt="image" src="https://github.com/user-attachments/assets/e2438746-d975-4a09-96b5-d73e5d1a9980" /> | | <img width="1327" alt="image" src="https://github.com/user-attachments/assets/bcf71617-a537-45e4-a5e8-452de946a238" /> | <img width="1277" alt="image" src="https://github.com/user-attachments/assets/71b34ff9-1aaf-4c39-ade1-7bb346aad317" /> | ## Considerations - Our tutorials are natively embedded and versioned in the website using Docusaurus, but our sphinx-generated API reference is not. ReadTheDocs will create new version of the sphinx docs for every new release tag in our github repo. - Continue using same integrations for Algolia Search and Google Analytics - The number and type of github workflows we have remain the same, but the complexity of the workflows and the supporting scripts has been simplified. Pull Request resolved: facebook#3289 Test Plan: - I've enabled all the workflows in my PR and everything is passing [https://github.com/CristianLara/botorch/actions](https://github.com/CristianLara/botorch/actions) - Pypy deploy and codecov are failing as expected due to missing credentials - Website for my fork is being actively built and served at [cristianlara.me/Ax](cristianlara.me/Ax) - API Reference is being built and served by ReadTheDocs at [https://ax.readthedocs.io/](https://ax.readthedocs.io/) Differential Revision: D68916590 Pulled By: CristianLara
CristianLara
added a commit
to CristianLara/Ax
that referenced
this pull request
Jan 31, 2025
Summary: Pull Request resolved: facebook#3294 ## Context This is the Ax counterpart to the same upgrade in Botorch: pytorch/botorch#2653 ## Motivation We are already using most of the correct tooling but it has become very out of date and is tied together with scripts that are difficult to maintain. Upgrade our tooling by updating to latest versions and dramatically simplifying our setup/deploy scripts. Includes: - Upgrade Docusaurus from V1 to V3 - Utilize new MDX support in Docusaurus by converting our tutorials to MDX (previously converted to html) - Tutorials link to Colab for easy execution - Website versioning is now handled natively through Docusaurus - New website versions are only created for major and minor releases (not patches) - Build and Deploy workflows have been dramatically simplified - Change Sphinx theme to ReadTheDocs - API Reference is still built using Sphinx but is now hosted by ReadTheDocs. ReadTheDocs also handles versioning. - Legacy website will be frozen and available at [archive.ax.dev](archive.ax.dev) - Served by Vercel from the `archive` branch - Website now supports dark mode | Before | After | | -------- | ------- | | <img width="1325" alt="image" src="https://github.com/user-attachments/assets/4af73120-f125-47e2-8285-bd01f4251ee9" /> | <img width="1330" alt="image" src="https://github.com/user-attachments/assets/ea17c47c-5012-47ab-a9d2-4b7e9c103cb0" /> | | <img width="1328" alt="image" src="https://github.com/user-attachments/assets/3dbde70a-8b84-43a4-8374-362f594de7fc" /> | <img width="1332" alt="image" src="https://github.com/user-attachments/assets/c779b7dd-76b9-4eb3-9b08-ca663732d7ec" /> | | <img width="1328" alt="image" src="https://github.com/user-attachments/assets/25d74ed7-4536-43a3-8654-ed291ae50cf3" /> | <img width="1331" alt="image" src="https://github.com/user-attachments/assets/e2438746-d975-4a09-96b5-d73e5d1a9980" /> | | <img width="1327" alt="image" src="https://github.com/user-attachments/assets/bcf71617-a537-45e4-a5e8-452de946a238" /> | <img width="1277" alt="image" src="https://github.com/user-attachments/assets/71b34ff9-1aaf-4c39-ade1-7bb346aad317" /> | ## Considerations - Our tutorials are natively embedded and versioned in the website using Docusaurus, but our sphinx-generated API reference is not. ReadTheDocs will create new version of the sphinx docs for every new release tag in our github repo. - Continue using same integrations for Algolia Search and Google Analytics - The number and type of github workflows we have remain the same, but the complexity of the workflows and the supporting scripts has been simplified. Pull Request resolved: facebook#3289 Test Plan: - I've enabled all the workflows in my PR and everything is passing [https://github.com/CristianLara/botorch/actions](https://github.com/CristianLara/botorch/actions) - Pypy deploy and codecov are failing as expected due to missing credentials - Website for my fork is being actively built and served at [cristianlara.me/Ax](cristianlara.me/Ax) - API Reference is being built and served by ReadTheDocs at [https://ax.readthedocs.io/](https://ax.readthedocs.io/) Differential Revision: D68916590 Pulled By: CristianLara
|
@CristianLara merged this pull request in 4702b26. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context
This is the Ax counterpart to the same upgrade in Botorch: pytorch/botorch#2653
Motivation
We are already using most of the correct tooling but it has become very out of date and is tied together with scripts that are difficult to maintain. Upgrade our tooling by updating to latest versions and dramatically simplifying our setup/deploy scripts.
Includes:
archivebranchConsiderations
Test Plan