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

marketplace: write instructions for transitioning #447

Merged
merged 1 commit into from
Nov 26, 2024

Conversation

jordigh
Copy link
Contributor

@jordigh jordigh commented Nov 23, 2024

There are very few users who should ever need to do this, so the instructions are a little sparse on details. I believe this to be an acceptable compromise.

Copy link

netlify bot commented Nov 23, 2024

Deploy Preview for grist-help-preview ready!

Name Link
🔨 Latest commit 8b2b801
🔍 Latest deploy log https://app.netlify.com/sites/grist-help-preview/deploys/674633d339454a00088e9140
😎 Deploy Preview https://deploy-preview-447--grist-help-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@jordigh jordigh force-pushed the jordigh/omnibus-transition branch 5 times, most recently from db88f64 to cfc3223 Compare November 23, 2024 00:20
Copy link
Member

@paulfitz paulfitz left a comment

Choose a reason for hiding this comment

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

With a few more details to help the user's mental model in case of problems (and there are always problems), this is close to fine. I was hoping for instructions that would help with transitioning any single-server setup, with some extra notes for AWS-specific steps, but maybe there isn't enough to say.

The main thing I'd like to see fleshed out is to systematically clue the user in on the default email wrinkle. It is dangerous and confusing to be setting up Grist without knowing what that is about. Feels like it merits a section in the self-managed handbook, rather than a very passing mention in telemetry which is all I see right now? https://support.getgrist.com/self-managed/#how-do-i-control-telemetry

It would be super helpful if you told users that this email will control access to the single team site that gets created for them on first run, and the consequences and symptoms of changing it. And that'll be valuable not only for AWS users but lots of other people.

help/en/docs/install/aws-marketplace-transition.md Outdated Show resolved Hide resolved
help/en/docs/install/aws-marketplace-transition.md Outdated Show resolved Hide resolved
help/en/docs/install/aws-marketplace-transition.md Outdated Show resolved Hide resolved
@jordigh jordigh force-pushed the jordigh/omnibus-transition branch 2 times, most recently from 5e730c2 to 6f2e8de Compare November 26, 2024 19:43
* The entire `~/grist-persist/docs` directory

Also see ["What files does Grist
store?"](../../self-managed#what-files-does-grist-storex) for an
Copy link
Contributor

@nbush nbush Nov 26, 2024

Choose a reason for hiding this comment

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

extra "x" on the URL

The traditional method to copy files across instances is `scp`, a file
transfer mechanism over the SSH protocol. A small complication is that
the user to copy to, `grist` in the target EC2 instance, by default
does not have ssh login enabled. We recommend copying into the default
Copy link
Contributor

Choose a reason for hiding this comment

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

"an SSH login" or "an ssh login"?

Copy link
Contributor

@nbush nbush left a comment

Choose a reason for hiding this comment

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

a couple tiny things

@jordigh jordigh force-pushed the jordigh/omnibus-transition branch from 6f2e8de to 8b2b801 Compare November 26, 2024 20:47
@jordigh jordigh merged commit 6859e41 into master Nov 26, 2024
5 checks passed
@jordigh jordigh deleted the jordigh/omnibus-transition branch November 26, 2024 20:51
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.

3 participants