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

[docs] Add header badge for PR staging instances #7347

Merged
merged 2 commits into from
Nov 7, 2023

Conversation

cee-chen
Copy link
Member

@cee-chen cee-chen commented Nov 7, 2023

Summary

It occurred to me on a whim today that our PR staging instances (e.g. https://eui.elastic.co/pr_7347) should likely show some affordance for what they are (a staging server) rather than using the plain old version switcher (#7298). Here's my proposal for the different environments:

Staging (link goes back to the originating GitHub PR)

Local (no link/switcher)

Production (version switcher)

QA

Check it out! https://eui.elastic.co/pr_7347/#/

General checklist

N/A, docs only

@cee-chen cee-chen added documentation Issues or PRs that only affect documentation - will not need changelog entries skip-changelog labels Nov 7, 2023
@cee-chen cee-chen marked this pull request as ready for review November 7, 2023 19:40
@cee-chen cee-chen requested a review from a team as a code owner November 7, 2023 19:40
@cee-chen
Copy link
Member Author

cee-chen commented Nov 7, 2023

@elastic/eui-team let me know what you think! Personally I think this is pretty useful (especially for demos or external links to a PR staging server where people may want to go to the original PR for more context).

Also looking for feedback on the badge color, is hollow too boring? Maybe we should use primary instead? :)

@kibanamachine
Copy link

Preview staging links for this PR:

@elasticmachine
Copy link
Collaborator

💚 Build Succeeded

History

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.

🚀 Wow, this is cool @cee-chen! I love the Staging link back to the PR, excellent touch.

@cee-chen
Copy link
Member Author

cee-chen commented Nov 7, 2023

Thanks Trevor!!

Going to go ahead and merge this so I can see it in action in a couple new/open PRs. But as always, if anyone has any feedback after the fact, just leave a comment - I'm always happy to open a follow-up PR or continue to tweak!

@cee-chen cee-chen merged commit 9c891fa into elastic:main Nov 7, 2023
8 checks passed
@cee-chen cee-chen deleted the pr-staging-badge branch November 7, 2023 22:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues or PRs that only affect documentation - will not need changelog entries skip-changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants