Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

help: Update wording of Caveats in import-from-hipchat.

This commit is contained in:
Rishi Gupta 2019-04-02 15:41:14 -07:00
parent 4924f7ad92
commit c65b82832e
1 changed files with 16 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
templates/zerver/help/import-from-hipchat.md
View File

@ -134,25 +134,23 @@ root domain. Replace the last line above with the following, after replacing
## Caveats ## Caveats
- While the import tool will correctly import the subscribers of While the import tool will correctly import the subscribers of private
private rooms precisely, HipChat does not store the subscribers of rooms, HipChat does not store or export the list of subscribers for public
public rooms when those users don't have an active client. As a
result, HipChat's data exports don't include subscribers for public
rooms. You can pick one of the following options for handling this: rooms. You can pick one of the following options for handling this:
1. Subscribe all users to all public streams (the default, which is
good for small organizations), * Subscribe all users to all public streams (the default, which is good for small organizations).
2. Subscribe only HipChat room owners to public streams (and plan
for users to subscribe to the imported Zulip streams manually * Subscribe only HipChat room owners to public streams (and plan for users
after the import completes) using the `--slim-mode` option to `manage.py to subscribe to the imported Zulip streams manually after the import
convert_hipchat_data`, or completes) using the `--slim-mode` option to `manage.py convert_hipchat_data`.
3. Use the [HipChat API][hipchat-api-tokens] to fetch each room's
current room subscribers as of the moment the import is run. * Use the [HipChat API][hipchat-api-tokens] to fetch each room's current
Because HipChat doesn't store subscribers to a room when clients room subscribers as of the moment the import is run. Because HipChat
are not connected, these subscriptons will be incomplete for users doesn't store subscribers to a room when clients are not connected, these
who don't have an actively connected client at the time of the subscriptons will be incomplete for users who don't have an actively
import. You need to pass the token via `--token=abcd1234` in connected client at the time of the import. You need to pass a HipChat
`manage.py convert_hipchat_data` (or include it in your request, access token via `--token=abcd1234` in `manage.py convert_hipchat_data`
if importing into Zulip Cloud). (or include it in your request, if importing into Zulip Cloud).
[upgrade-zulip-from-git]: https://zulip.readthedocs.io/en/latest/production/maintain-secure-upgrade.html#upgrading-from-a-git-repository [upgrade-zulip-from-git]: https://zulip.readthedocs.io/en/latest/production/maintain-secure-upgrade.html#upgrading-from-a-git-repository
[hipchat-api-tokens]: https://developer.atlassian.com/server/hipchat/hipchat-rest-api-access-tokens/ [hipchat-api-tokens]: https://developer.atlassian.com/server/hipchat/hipchat-rest-api-access-tokens/