search

src-d / sourced-ce

source{d} Community Edition (CE)
https://docs.sourced.tech/community-edition
GNU General Public License v3.0
188 stars 51 forks source link

[DOCS] Enhance the UX when restoring postgres db #216

Closed dpordomingo closed 5 years ago

dpordomingo commented 5 years ago

sourced restart is slower than just waking up the new DB container, and loading the dashboards. (especially when developing, when the user might be interested in keeping the current container)

dpordomingo commented 5 years ago

Feel free to directly close this PR if this is going to be fully addressed by the new update command (we don't have its specs yet)

carlosms commented 5 years ago

To me it seems a bit too low level for end users FAQ. It's nice that a developer can do that, but for end users we already have restart, even if it is slower. Even more, we already have sourced prune and init again for this use case. I think it makes more sense to move to this direction (sourced commands) when possible for end-user docs.

dpordomingo commented 5 years ago

I see your point, and it's totally legit. But we're already explaining how to restore the dashboards using advanced commands like dropping volumes... Why not continuing improving the user experience in that direction?

Would it be better if we move this advanced commands deeper in the docs? Or what if we let sourced handle this feature internally?

se7entyse7en commented 5 years ago

I agree with @carlosms that it would be better to show how-tos using sourced commands whenever it's possible.

Regarding this specific use-case, maybe we could provide a sourced reset command that works as a reset to factory defaults. So this would do a sourced prune and a restore of the default charts for the current version.

dpordomingo commented 5 years ago

Prune and init would not satisfy the same usecase, because it does not keep repos, metada nor indexes.

From my pov, we should consider if the usecase is legit: if it is, try to improve the current experience, or provide a better way; if it is not alegit usecase, drop it from the docs.

Maybe @src-d/product could confirm if restoring the UI state is a feature that we want to provide.

smacker commented 5 years ago

These commands are needed only for development. Prune+init covers all the user needs for reset. Let's move it into contributing document instead or just remove.

dpordomingo commented 5 years ago

Moving it to CONTRIBUTING might be a good solution. Thanks for suggesting.

dpordomingo commented 5 years ago

Moved into CONTRIBUTING.md as suggested by @smacker https://dpordomingo.gitbook.io/community-edition/learn-more/contributing#how-to-restore-dashboards-and-charts-to-defaults