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

help-docs: Move help center documentation to top level directory.

Browse Source 
These files are not Jinja2 templates, so there's no reason that they needed
to be inside `templates/zerver`. Moving them to the top level reflects their
importance and also makes it feel nicer to work on editing the help center content, 
without it being unnecessary buried deep in the codebase.
This commit is contained in:
Lauryn Menard
2023-01-25 23:08:29 +01:00
committed by GitHub
parent 6cf1d9fa20
commit dedea23745
269 changed files with 40 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
docs/documentation/helpcenter.md
View File

@@ -26,20 +26,18 @@ from the Internet, and we'd like the documentation to be available in that
environment.
The source for help center documentation is the Markdown files under
`templates/zerver/help/` in the
[main Zulip server repository](https://github.com/zulip/zulip). The file
`foo.md` is automatically rendered by the `render_markdown_path` function in
`zerver/templatetags/app_filters.py` when the user accesses a URL of the
form `/help/foo`; with special cases for `/help/` going to `index.md` and
`/help/unknown_article` going to `missing.md` (with a 404 response). Images
are usually linked from `static/images/help/`.
`help/` in the [main Zulip server repository](https://github.com/zulip/zulip).
The file `foo.md` is automatically rendered by the `render_markdown_path`
function in `zerver/templatetags/app_filters.py` when the user accesses a URL
of the form `/help/foo`; with special cases for `/help/` going to `index.md`
and `/help/unknown_article` going to `missing.md` (with a 404 response).
Images are usually linked from `static/images/help/`.
This means that you can contribute to the Zulip help center documentation
by just adding to or editing the collection of Markdown files under
`templates/zerver/help`. If you have the Zulip development environment
set up, you simply need to reload your browser on
`http://localhost:9991/help/foo` to see the latest version of `foo.md`
rendered.
`help/...`. If you have the Zulip development environment set up, you simply
need to reload your browser on `http://localhost:9991/help/foo` to see the
latest version of `foo.md` rendered.
This system is designed to make writing and maintaining such documentation
highly efficient. We link to the docs extensively from the landing pages and
@@ -69,9 +67,8 @@ the current documentation as a resource and guide as you begin.
- Should the feature you're documenting be added or merged into an
existing article?
- If so, you can locate that article in
`templates/zerver/help` and start working on updating it with
content about the new feature.
- If so, you can locate that article in `help/` and start working
on updating it with content about the new feature.
- If not, choose an existing article to use as a template for your
new article and make a list of which articles (or guides) would be
@@ -352,8 +349,7 @@ make use of `fa` as a base class.
phrases and steps at the location of the macros. Macros help eliminate
repeated content in our documentation.
The source for macros is the Markdown files under
`templates/zerver/help/include` in the
The source for macros is the Markdown files under `help/include` in the
[main Zulip server repository](https://github.com/zulip/zulip).
- **Administrator only feature** `{!admin-only.md!}`: Notes that the feature