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

Confusing upgrade docs instructions #4172

Open
pavish opened this issue Jan 24, 2025 · 2 comments
Open

Confusing upgrade docs instructions #4172

pavish opened this issue Jan 24, 2025 · 2 comments
Labels
restricted: maintainers Only maintainers can resolve this issue work: documentation Improvements or additions to documentation

Comments

@pavish
Copy link
Member

pavish commented Jan 24, 2025

Description

  • Open docs for 0.2.0: releases/0.2.0.
  • Notice that the Summary says users would have to reinstall and we don't support upgrades.
  • Notice that there's a section for Upgrades in the same page.
  • The Upgrade section mentions that users will lose all user accounts and explorations.
    • Calling this an "Upgrade" is confusing to me.

Expectation

  • Be clear on what we support reg., upgrades in the Summary.
  • Do not have a title called "Upgrade", since we don't actually perform any upgrade.
    • This is the most confusing part for me.
  • Perhaps rename it to: 'Recover the databases you created from previous installations'.
@pavish pavish added restricted: maintainers Only maintainers can resolve this issue work: documentation Improvements or additions to documentation labels Jan 24, 2025
@pavish pavish added this to the v0.2.0 (beta release) milestone Jan 24, 2025
@seancolsen
Copy link
Contributor

@pavish note that @mathemancer and I are both actively working on the upgrade instructions in #4168

@seancolsen seancolsen mentioned this issue Jan 24, 2025
7 tasks
@mathemancer
Copy link
Contributor

Yeah, I'm not sure what to call it. From our perspective, "upgrade" isn't correct. But I think most of our users consider Mathesar to be a single unit, with the "user databases" as part of it. From that perspective, this operation is an "upgrade that loses some (meta) data", and we should manage expectations with that in mind.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
restricted: maintainers Only maintainers can resolve this issue work: documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants