Commit Graph

299 Commits

Author SHA1 Message Date
Rishi Gupta eedad34b3c user docs: Add an organization basics section.
This section has the docs a new admin might look at during initial set up.

Does not add or remove articles, just moves stuff around on the
sidebar. Does remove the "Miscellaneous" section.
2017-10-05 23:12:24 -07:00
Rishi Gupta 0474402c51 user docs: Organize message sending and reading docs.
Collects all relevant docs into "Sending Messages" and "Reading Messages".

Doesn't add or remove any docs, just moves them around on the sidebar.
Duplicates "Message a stream by email" (it now appears in two sections)
Removes the "Editing Messages" section/header.
2017-10-05 23:12:24 -07:00
Rishi Gupta 6cccb70922 user docs: Reorganize account basics section.
This section should be the stuff we want users to see when they are first
setting up their account.

This commit only moves links on the sidebar around, no additions or
deletions.
2017-10-05 23:12:24 -07:00
Rishi Gupta 074826485f user docs: Update wordings on left sidebar. 2017-10-05 23:12:24 -07:00
Tim Abbott 14b7add4c4 help: Reorganize the sections somewhat. 2017-10-03 11:19:07 -07:00
Cynthia Lin ea75772a01 user docs: Add index page for searching. 2017-10-03 11:13:36 -07:00
Eeshan Garg 37fbed0993 webhooks: Recommend creating "incoming webhook" bot.
In all our webhooks' docs, we now recommend creating a bot with the
"Incoming webhook" bot type.
2017-07-11 13:25:51 -04:00
Eeshan Garg 085ce20feb markdown: Recommend installing bindings to the server with bot.
Instead of recommending our users to download and install our
bindings "to the <integration_name> server", we now recommend
installing our bindings "to the server where the
<integration_name> bot lives". Technically, the latter is more
accurate.
2017-06-26 12:30:04 -04:00
Eeshan Garg 1d9ab996c7 markdown: Clarify stream name recommendations in create-stream.
Now, we further clarify in the create-stream.md macro that even
if users follow our default stream name recommendation for a
given integration, said stream must still be explicitly created.
2017-06-26 12:30:04 -04:00
Eeshan Garg 242162f9db markdown: Add macros for changing integration config files. 2017-06-26 12:30:04 -04:00
Eeshan Garg 0d817f0870 markdown: Add macro for appending stream name to integration URL. 2017-06-14 17:42:17 -07:00
Eeshan Garg aa25348ddc markdown: Recommend substituting bot email and API key in URL.
We now recommend substituting the appropriate bot email and
API key in the webhook URL in the webhook-url-with-bot-email.md
macro.
2017-06-14 17:42:14 -07:00
Eeshan Garg 8efb3aeee7 templates: Update .md macros to use recommended_stream_name.
Previously, we used Integration.name as the recommended stream
in our macros. Now, we have a dedicated attribute set in the
Integration class (that WebhookIntegration and GithubIntegration
inherit from) for the recommended stream name in cases where
the stream name is different than the name of the integration
itself.
2017-06-13 15:30:35 -07:00
Aditya Bansal 7f15cfea91 integrations: Add download python bindings macro.
This will be used in various integration docs.
2017-06-06 21:40:27 -07:00
Eeshan Garg 3c47efb1fc templates: Add macro for appending branches to webhook URLs.
This macro is an alternative to git-webhook-url-with-branches.md,
which contains the full URL with a `branches` query parameter at
the end. This macro is for when we just want to specify that this
can be done but the URL to append to can be variable or is unique
to a particular integration (and thus, doesn't warrant its own
macro and a full URL example).
2017-06-05 11:22:06 -07:00
Eeshan Garg 433686457a templates: Add Markdown macro for URLs with bot_email@api_key. 2017-06-05 11:22:06 -07:00
Eeshan Garg fab20ec6fd templates: Add macro for appending branch names to Git webhook URLs. 2017-06-05 11:20:48 -07:00
Eeshan Garg af88695c28 templates: Add macro for appending the topic to the webhook URL. 2017-06-01 22:16:10 -07:00
Eeshan Garg dd5ce955bd webhooks/delighted: Migrate docs to Markdown. 2017-05-28 18:44:00 -07:00
Eeshan Garg 14ce3a94db webhooks/codeship: Migrate docs to Markdown. 2017-05-28 18:44:00 -07:00
Eeshan Garg 3cb758d339 templates: Support parametric Markdown macros for webhooks docs. 2017-05-24 17:00:19 -07:00
Eeshan Garg 2e3081e93d webhooks: Add Markdown macros for repetitive documentation. 2017-05-22 18:19:14 -07:00
Abhijeet Kaur 8f88b045a4 Rename "Administration" to "Organization" in the settings UI.
This better sets expectatations for the fact that in Zulip, the
Organization settings UI is available read-only to non-administrator
users.

Tweaked by tabbott to update some additional references.
2017-04-07 17:32:56 -07:00
Tim Abbott 3b59e6c3cc subs: Rename /#subscriptions to /#streams.
Fixes #3653.
2017-03-08 16:57:58 -08:00
Tim Abbott b3c9e186f9 help: Clean up change-your-organization-settings. 2017-01-29 23:02:20 -08:00
synicalsyntax 969b6db7ed docs: Rename documentation URLs and titles to be the same. 2017-01-29 22:56:23 -08:00
Cynthia Lin 0e543c7bad docs: Create and use *Administrator only feature* macro. 2017-01-17 14:45:15 -08:00
Cynthia Lin 11f36df37c docs: Create *Save changes* macro. 2017-01-16 19:59:37 -08:00
Tim Abbott 56bc421a6f Rename 'Filter Streams' to 'Filter streams'. 2017-01-16 18:00:10 -08:00
Tim Abbott 284931967a Rename 'All Streams' to 'All streams'. 2017-01-16 18:00:10 -08:00
Tim Abbott dd8fb093c8 Rename 'Stream Settings' to 'Stream settings'. 2017-01-16 18:00:10 -08:00
Cynthia Lin 1b173ee99a docs: Create *Follow steps* macro. 2017-01-15 11:16:18 -08:00
synicalsyntax c9eaf67c78 docs: Update documentation styling guide with new guidelines. 2017-01-05 20:23:26 -08:00
synicalsyntax 9d09ab11a9 docs: Replace images with FontAwesome icons. 2017-01-05 16:43:00 -08:00
Tim Abbott bc4a9ff722 lint: Enforce no lines longer than 120 characters in help docs.
This requires some somewhat messy changes to the all-streams macro.
2017-01-05 14:54:04 -08:00
Cynthia Lin 083c331e2d docs: Create *Stream Settings* macro. 2017-01-05 13:40:45 -08:00
Cynthia Lin d49b119391 docs: Create *Stream Settings scroll* macro. 2017-01-05 13:40:45 -08:00
Cynthia Lin ae79bb9f01 docs: Create *Stream actions* macro. 2017-01-05 13:40:45 -08:00
Cynthia Lin eff16b9766 docs: Create *Message actions* macro. 2017-01-05 13:40:45 -08:00
Cynthia Lin 097fbdefe4 docs: Create *Filter Streams* macro. 2017-01-05 13:40:45 -08:00
Cynthia Lin 6ad98e83b9 docs: Create *Down Chevron* macro. 2017-01-05 13:40:45 -08:00
Cynthia Lin 7f9b1b6490 docs: Create *All Streams* macro. 2017-01-05 13:40:45 -08:00
Cynthia Lin 89e9d79bb6 docs: Modify *Subscriptions* macro.
Modified to more resemble format of *Settings* and *Administration* macros.
2017-01-05 13:40:45 -08:00
synicalsyntax e1c9d0f814 user docs: Modify *Settings* macro to use *Go to the* macro.
Created a *Go to the* macro that can be used by both *Settings* and
*Administration* macro.
2017-01-04 08:50:38 -08:00
synicalsyntax a36d39f774 user docs: Create *Administration* macro. 2017-01-04 08:50:38 -08:00
synicalsyntax ab9356ad44 user docs: Remove outdated *Settings* macro. 2017-01-04 08:50:38 -08:00
Cynthia Lin 742d19c1b0 user docs: Create *Settings* macro. 2017-01-03 16:15:51 -08:00
Cynthia Lin 1118d303dc user docs: Add the subscriptions macro. 2017-01-01 19:49:14 -08:00
Tim Abbott 687d0cbf9e docs: Add support for including markdown files in others.
This uses a third-party dependency, python-markdown-include.

The example use for settings is intended primarily as a demonstration.
2016-12-30 17:16:29 -08:00