brimdata / super

A novel data lake based on super-structured data
https://zed.brimdata.io/
BSD 3-Clause "New" or "Revised" License
1.38k stars 64 forks source link

Rewrite top-level docs page with "super" naming #5336

Closed philrz closed 16 hours ago

philrz commented 5 days ago

A rendered draft is staged at https://spiffy-gnome-8f2834.netlify.app/docs/next

Goals in renaming as affects docs

We know we want to:

  1. Allow our existing users to be able to continue using the tools as they have been, even as the project/command names change (so, even as SuperSQL becomes the hot new item, we still want materials about SuperPipe, the data formats, etc., to still be readable and accurate even in the new naming scheme)
  2. Make way to begin introducing new concepts like SuperSQL

What I'm attempting here

This is a small step in the overall renaming effort to try out the new "super"-centric names.

We know the renaming is not a simple search-and-replace of "zed" with "super", so I wanted to confirm that the current proposed from/to list feels ok when applied to the existing materials. I've started with a rewrite of the first page users see when they land at https://zed.brimdata.io/docs/next

I've done some minimal reworking of sentence structure and moving paragraphs around where it felt necessary, but I've kept the overall content intact.

If this passes muster my hope is that we can begin re-using the new terms in similar ways as we attack more docs pages, READMEs in the repos, web site content, etc.

What I'm not attempting (yet)

In this pass I'm intentionally not trying to:

  1. Overhaul the top-level positioning
  2. Introduce SuperSQL

...though I fully expect these things will happen in subsequent passes.