element-hq/ems-docs

Document RocketChat import formats

Open

#73 opened on Feb 28, 2022

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Handlebars (9 forks)auto 404
enhancementgood first issue

Repository metrics

Stars
 (7 stars)
PR merge metrics
 (PR metrics pending)

Description

We have some documentation around the expected migration format here: https://ems.element.io/tools/rocket-chat-migration

  1. Clarify what file format mongodump produces. It might be stated in the official mongodump documentation. A customer tried to upload a tar.gz which got accepted at first but failed during the migration.
  2. Add section about importing data from RocketChat that is installed via Canonical's Snap. Its data export will produce a tar.gz file.

Contributor guide

Research direction
Review the existing documentation at https://ems.element.io/tools/rocket chat migration, then consult the official mongodump documentation to clarify the file format. Also research RocketChat snap installations to document the tar.gz export process.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Markdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90