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

Add initial doc regarding Space migration #1587

Merged
merged 2 commits into from
May 5, 2021
Merged

Add initial doc regarding Space migration #1587

merged 2 commits into from
May 5, 2021

Conversation

philrz
Copy link
Contributor

@philrz philrz commented Apr 26, 2021

Part of the plan for #1567 includes an article we can link to from our Space migration UX. While we're hopeful the migration tools should be seamless enough that users shouldn't need to read any supplemental materials to use it, some things I hope to accomplish by having an article:

  1. Educate the curious users on Zed Lakes & Data Pools to provide more detail (and links to even more detail) on why we've switched to this approach, how it benefits them, etc.
  2. We can continue change and/or add to the article if we notice user confusion or bugs as users start to upgrade & migrate

There's a bit of a chicken/egg snag where the article needs to exist before we can link to it from the tools, so here I've started a placeholder article with a stab at some minimal content. As the migration tooling comes together, I'll plan to expand it with screenshots and such.

While I took a crack at summarizing some of the goodness of Lakes/Pools, please don't mistaken this for official marketing copy. I fully expect we're going to to have many more words to say on these topics in the web site, blog posts, etc., and as that wording comes together I fully expect the summary can be revised accordingly. That said, if you think I badly misrepresented something or left out something essential, I'm all ears.

@philrz philrz requested review from mccanne, mattnibs, nwt and a team April 26, 2021 21:51
@philrz philrz self-assigned this Apr 26, 2021
Copy link
Member

@jameskerr jameskerr left a comment

Choose a reason for hiding this comment

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

I'll link to this in the UI when I start building it.


When upgrading to GA Brim release `v0.25.0` or newer, any data you had stored
in Spaces that you wish to continue accessing will need to be migrated to
pools. The tooling to perform this migration is still under development. This
Copy link
Member

Choose a reason for hiding this comment

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

I see "Spaces" was capitalized but "pools" was lower case. Not sure which is correct but they seem on the same level.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point @jameskerr. I just pushed a commit to capitalize the "Pool" references also. Merging!

@philrz philrz merged commit 992f50b into main May 5, 2021
@philrz philrz deleted the migration-doc branch May 5, 2021 17:26
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.

2 participants