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

build: deploy new docs #7409

Merged
merged 3 commits into from
Dec 7, 2023
Merged

Conversation

tkajtoch
Copy link
Member

@tkajtoch tkajtoch commented Dec 7, 2023

Summary

This PR resolves #7402 by updating build_docs and deploy_docs to build the new docs site and deploy it under new-docs directory.

QA

  • Code changes look valid
  • docusaurus site PR preview is deployed and accessible

@tkajtoch tkajtoch requested a review from 1Copenut December 7, 2023 19:14
@tkajtoch tkajtoch self-assigned this Dec 7, 2023
@tkajtoch tkajtoch requested a review from a team as a code owner December 7, 2023 19:14
Copy link
Contributor

@1Copenut 1Copenut left a comment

Choose a reason for hiding this comment

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

Just one suggested change to add the trailing slash to the Docusaurus URL and I think we're good to go here. The Docusaurus env variable displayed correctly and the docs site was accessible from the GitHub PR page.

Comment on lines 58 to 59
- Storybook: https://eui.elastic.co/pr_${GIT_PULL_REQUEST_ID}/storybook
- New docs site (in development): https://eui.elastic.co/pr_${GIT_PULL_REQUEST_ID}/new-docs"
Copy link
Contributor

Choose a reason for hiding this comment

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

This URL doesn't have the trailing / at the end of the Docusaurus link, and I think that's what's causing the docs header to display twice when the URL resolves to /new-docs/index.html. If I add the trailing slash, it shows the header properly and has the same URL as the EUI logo in the docs preview site.


Screenshot 2023-12-07 at 2 03 33 PM

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, this is strange. I'm testing some configuration variations to see if we can fix it without forcing that slash there just in case it would cause troubles when deployed to / in the future

@tkajtoch tkajtoch force-pushed the feat/deploy-new-docs branch from 0210750 to 445db1f Compare December 7, 2023 21:24
@kibanamachine
Copy link

Preview staging links for this PR:

@elasticmachine
Copy link
Collaborator

💚 Build Succeeded

History

cc @tkajtoch

Copy link
Contributor

@1Copenut 1Copenut left a comment

Choose a reason for hiding this comment

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

👍 LGTM!

@tkajtoch tkajtoch merged commit 22afd1f into elastic:feat/new-docs Dec 7, 2023
tkajtoch added a commit that referenced this pull request Dec 13, 2023
tkajtoch added a commit to tkajtoch/eui that referenced this pull request Jan 22, 2024
tkajtoch added a commit that referenced this pull request Jan 22, 2024
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.

4 participants