paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-10-24 16:43:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

documentation: Update tutorial for writing help center documentation.

Browse Source 
Updates the tutorial for writing help center articles to encourage
contributors to add to or enhance the existing help center docs
before writing a new articles for new features.

Also, generally updates references to 'user documentation' to be
'help center documentation'.

Additionally, updates some headers within the tutorials for clarity
and consistency, and adds some linkifying throughout the section on
writing documentation.
This commit is contained in:
Lauryn Menard
2021-12-17 15:59:58 +01:00
committed by Tim Abbott
parent 048c9b99e3
commit 784f923dda
7 changed files with 122 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/tutorials/new-feature-tutorial.md
View File

@@ -156,10 +156,11 @@ any existing documentation that might be relevant to the new feature.
For detailed information on the kinds of documentation Zulip has, see
[Documentation](../documentation/overview.md).
**End user documentation:** You will likely need to at least update,
extend and link to `/help` articles that are related to your new
feature. See [User documentation](../documentation/user.md) for more
detailed information about writing and editing feature `/help` articles.
**Help center documentation:** You will likely need to at least update,
extend and link to `/help/` articles that are related to your new
feature. [Writing help center articles](../documentation/user.md)
provides more detailed information about writing and editing feature
`/help/` articles.
**API documentation:** A new feature will probably impact the REST API
documentation as well, which will mean updating `zerver/openapi/zulip.yaml`
@@ -686,15 +687,15 @@ important to make sure that your new feature is well documented.
This example feature adds new functionality that requires messages to
have topics if the setting is enabled. A recommended way to document
this feature would be to update and/or augment Zulip's existing
[end user documentation (Help Center)](https://zulip.com/help/)
to reflect your changes and additions.
[help center documentation](https://zulip.com/help/) to reflect your
changes and additions.
At the very least, this will involve modifying (or adding) a Markdown
file documenting the feature to `templates/zerver/help/` in the main
Zulip server repository, where the source for Zulip's end user
documentation is stored. Details about writing, editing and testing
these Markdown files can be found in:
[User documentation](../documentation/user.md).
[Writing help center articles](../documentation/user.md).
Also, new features will often impact Zulip's REST API documentation,
which is found in `zerver/openapi/zulip.yaml`. You may have noticed