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

Stop showing Next and add an announcement bar about SuperDB docs #87

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

philrz
Copy link
Contributor

@philrz philrz commented Nov 20, 2024

This is related to other PRs:

In the time we've started the Zed->SuperDB transition, the "Next" selection in the versions drop-down on https://zed.brimdata.io/ has been showing the work-in-progress SuperDB docs. This has been as good a home as any for pointing early SuperDB users at relevant pages that speak to the new stuff. However, brimdata/super#5489 is going to change the markdown in the Zed repo such that it'll no longer contain the Docusaurus-specific parts so it won't even be possible to publish the SuperDB docs here once that merges, and that's fine because https://github.com/brimdata/superdb-website/pull/6 will make it possible to publish them instead at their proper home as part of https://superdb.org/.

This PR does two things to make way for that transition:

  1. The "Next" selection will no longer appear in the versions drop-down. Now the drop-down will only include GA releases up to v1.18.0 which was the final one known by the "Zed" name. These Docusaurus config docs taught me about the includeCurrentVersion setting used to achieve this.

  2. An announcement bar is added to make users aware where the new SuperDB docs can be found.

We could potentially make other changes to be doubly sure users know about the transition (e.g., we could change what's on the initial https://zed.brimdata.io/ page, add some prominent text near the top of https://zed.brimdata.io/docs in the versioned v1.18.0 docs in this repo to mention SuperDB, etc.) but what's here should get us started.

I've published a build based on this branch to a personal staging site at https://spiffy-gnome-8f2834.netlify.app/ if anyone wants to give it a look. A screenshot that highlights the important differences:

image

The one timing consideration of when this merges is that we'd only want to do it once https://superdb.org/docs is "live" to some degree, since the link in the announcement bar is pointing there early.

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.

1 participant