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

Update banner for master doc versions #3031

Merged
merged 6 commits into from
Jul 16, 2024
Merged

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jul 10, 2024

This PR updates the banner that appears in "master" versions of the documentation, since it's currently unclear about the state of the serverless details in that branch.

Before

image

After

image

Copy link

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@lcawl lcawl marked this pull request as ready for review July 10, 2024 20:40
@lcawl lcawl requested a review from a team as a code owner July 10, 2024 20:40
@dedemorton
Copy link
Contributor

I wonder if we can change this banner to be less confusing and provide users with a call to action. Maybe something like:

"You are looking at non-versioned documentation that may not be accurate if you're using a versioned Elastic Stack product. To see the documentation for the correct version, use the version selector."

@leemthompo
Copy link
Contributor

Thanks for this @lcawl, I think it makes a lot of sense to tackle some of this confusion in the banner.

I agree with @dedemorton that it would be nice to have a CTA but we also need to address the serverless disambiguation.

Here's a cut, with two blocks of text:

This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs.

This documentation also contains the latest Elastic Cloud serverless information. For our serverless-specific documentation, check out our serverless docs.

@lcawl lcawl marked this pull request as draft July 15, 2024 16:31
@lcawl lcawl marked this pull request as ready for review July 15, 2024 17:58
@lcawl
Copy link
Contributor Author

lcawl commented Jul 15, 2024

Here's a cut, with two blocks of text:

I like that suggestion @leemthompo but I pruned it down a bit since the two blocks of text took up a lot of room at the top of each page.

@lcawl lcawl merged commit c139d7a into elastic:master Jul 16, 2024
3 checks passed
@lcawl lcawl deleted the master-banner branch July 16, 2024 17:00
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