exports: Update wording on settings page, /help and /features.

This commit is contained in:
Rishi Gupta 2019-08-14 13:43:00 -07:00 committed by Tim Abbott
parent cbbfb19692
commit 02cfb47315
4 changed files with 58 additions and 41 deletions

View File

@ -1,10 +1,18 @@
<div id="data-exports" class="settings-section" data-name="data-exports-admin"> <div id="data-exports" class="settings-section" data-name="data-exports-admin">
<p class="alert-word-settings-note">{{#tr this}}Depending on the size of your organization, the time to complete an export can range from several minutes to an hour.{{/tr}}</p>
<h3>{{t "Data exports" }} <h3>{{t "Data exports" }}
<a href="/help/export-your-organization" target="_blank"> <a href="/help/export-your-organization" target="_blank">
<i class="fa fa-question-circle-o" aria-hidden="true"></i> <i class="fa fa-question-circle-o" aria-hidden="true"></i>
</a> </a>
</h3> </h3>
<p>
{{t 'Exports all users, settings, and all data visible in public streams.' }}
{{t 'Any organization administrator can conduct an export.'}}
{{t 'Depending on the size of your organization, an export can take anywhere from seconds to an hour.' }}
</p>
<p>
{{#tr this}}<a href="/help/export-your-organization" target="_blank">Click here</a> to learn about exporting private streams and messages.{{/tr}}
{{t 'Note that organizations are limited to five exports per week.' }}
</p>
{{#if is_admin}} {{#if is_admin}}
<div class="alert" id="export_status" role="alert"> <div class="alert" id="export_status" role="alert">
@ -17,15 +25,10 @@
{{t 'Start public export' }} {{t 'Start public export' }}
</button> </button>
</div> </div>
<p class="alert-word-settings-note">{{#tr this}}Zulip also supports exporting private streams and messages under some circumstances. <a href="/help/export-your-organization" target="_blank">Read more</a>{{/tr}}</p>
</div> </div>
</form> </form>
{{/if}} {{/if}}
<p class="alert-word-settings-note">{{#tr this}}Any member with administrative access can conduct an export. Please note that individual organizations are limited to five exports per week.{{/tr}}</p> <div class="admin-table-wrapper">
<input type="text" class="search" placeholder="{{t 'Filter exports' }}"
aria-label="{{t 'Filter exports' }}"/>
<div class="progressive-table-wrapper admin-table-wrapper" data-simplebar data-list-render="admin-exports-list">
<table class="table table-condensed table-striped wrapped-table admin_exports_table"> <table class="table table-condensed table-striped wrapped-table admin_exports_table">
<thead> <thead>
<th class="active" data-sort="user">{{t "Requesting user" }}</th> <th class="active" data-sort="user">{{t "Requesting user" }}</th>

View File

@ -284,6 +284,13 @@
A full suite of tools for moderating open communities. A full suite of tools for moderating open communities.
</p> </p>
</a> </a>
<a class="feature-block" href="/help/export-your-organization" target="_blank">
<h3>DATA EXPORTS</h3>
<p>
No vendor lock-in. Export your hosted Zulip to an
on-premises installation at any time.
</p>
</a>
<a class="feature-block" href="https://github.com/zulip/zulip/" target="_blank"> <a class="feature-block" href="https://github.com/zulip/zulip/" target="_blank">
<h3>YOUR FEATURE HERE</h3> <h3>YOUR FEATURE HERE</h3>
<p>Zulip is open source, so if something important for <p>Zulip is open source, so if something important for

View File

@ -21,55 +21,60 @@ three types of zulipchat.com exports.
All organizations have access to the first two kinds of export. Only corporate All organizations have access to the first two kinds of export. Only corporate
Zulip Standard customers have access to **full export without member consent**. Zulip Standard customers have access to **full export without member consent**.
## Request an export ## Public export
The general pattern for all three types of export is {start_tabs}
1. Email support@zulipchat.com with your zulipchat.com subdomain, the type {settings_tab|data-exports-admin}
of export you need, and additional information as needed for full exports
(see below). Email us from the same address that you use to sign in
to Zulip.
2. We will check that you are an organization administrator, and email you 1. Click **Start public export**.
and all other organization administrators asking for a confirmation.
3. Reply confirming. 1. After a few minutes, you'll be able to download the export as a `.tar.gz`
file from that page.
4. We will email a download link with the export to all administrators in {end_tabs}
the organization.
We can work with you to schedule a time for the export, to minimize downtime Note that generating the export can take up to an hour for organizations
during a transition from Zulip Cloud to an on-premises installation. with lots of messages or uploaded files.
## Additional info needed for full exports ## Full export with member consent
For **full export with member consent**, you will need to prove to us {start_tabs}
which members' data you have consent to export (there are a few secure
and convenient options for doing this; contact support for details).
Such an export will include all the messages received by any user in 1. Email support@zulipchat.com with your zulipchat.com subdomain, asking for
the organization that consented to the data export. In particular, it a full export with member consent. Email us from the same address that
will include all public stream content and any private stream or you use to sign in to Zulip.
private message content where at least one of the participants gave
consent. 1. We will verify that you are an organization administrator, and email you
instructions on how to collect member consent.
{end_tabs}
Note that such an export will include all the messages received by any user
in the organization that consents to the data export. In particular, it
will include all public stream content and any private stream or private
message content where at least one of the participants gives consent.
Users who do not provide consent will have their settings and stream Users who do not provide consent will have their settings and stream
subscriptions exported, but will otherwise be treated as new users after subscriptions exported, but will otherwise be treated as new users after
import. import.
For **full export without member consent**, we will additionally need ## Full export without member consent
evidence that you have authority to read members' private
messages. Typically, this will be because the zulipchat.com subdomain
is administered by a corporation, and you are an official
representative of that corporation. By requesting and approving this
export, you also assume full legal responsibility that the appropriate
employment agreements and corporate policy for this type of export are
in place. Note that many countries have laws that require employers to
notify employees of their use of such an export.
**Full export without member consent** is additionally limited to paid This export is limited to paid Zulip Standard customers, though in rare
Zulip Standard customers, though in rare cases may be available to cases may be available to other organizations in case of due legal process.
other organizations in case of due legal process.
To start this export, email support@zulipchat.com with your zulipchat.com
subdomain, asking for a full export without member consent.
You'll also need to email us evidence that you have authority to read
members' private messages. Typically, this will be because the zulipchat.com
subdomain is administered by a corporation, and you are an official
representative of that corporation. By requesting and approving this export,
you will also assume full legal responsibility that the appropriate employment
agreements and corporate policy for this type of export are in place. Note
that many countries have laws that require employers to notify employees of
their use of such an export.
## Related articles ## Related articles

View File

@ -47,6 +47,8 @@ link_mapping = {
'/#organization/profile-field-settings'], '/#organization/profile-field-settings'],
'invites-list-admin': ['Manage organization', 'Invitations', 'invites-list-admin': ['Manage organization', 'Invitations',
'/#organization/invites-list-admin'], '/#organization/invites-list-admin'],
'data-exports-admin': ['Manage organization', 'Data exports',
'/#organization/data-exports-admin'],
} }
settings_markdown = """ settings_markdown = """