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

docs: Update import-from-gitter doc. #10096

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 15 additions & 3 deletions templates/zerver/help/import-from-gitter.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ First, export your data from Gitter.
Zulip.

!!! warn ""
**Note:** You'll need a gitter API token to export data. You can get
this token by following the instructions in the
**Note:** You'll need a gitter API token to export data. You can get this
token by following the instructions in the "**Getting Started**" section of the
[gitter documentation](https://developer.gitter.im/docs/).

### Import into zulipchat.com
Expand Down Expand Up @@ -63,13 +63,25 @@ you'd like for your imported Zulip organization.

{!import-login.md!}

## Create organization administrators

Gitter API doesn't include the admin data of the organization.
Use the instructions mentioned in the
[documentation](
https://zulip.readthedocs.io/en/latest/production/maintain-secure-upgrade.html#grant-administrator-access)
to grant administrative access to a user.

## Caveats

- The [Gitter data export](https://github.com/minrk/archive-gitter)
that powers this doesn't support exporting private gitter rooms.

- The [Gitter API](https://developer.gitter.im/docs/user-resource)
doesn't include the admin data of the organization.

- This tool doesn't do any translation of the Gitter markdown into
Zulip format markdown; additionally, Gitter's "issue mentions"
Zulip format markdown; additionally, Gitter's
[issue mentions](https://gitter.zendesk.com/hc/en-us/articles/200176692-Issue-and-Pull-Request-mentions)
aren't translated into anything yet.

[upgrade-zulip-from-git]: https://zulip.readthedocs.io/en/latest/production/maintain-secure-upgrade.html#upgrading-from-a-git-repository