Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
60,813 Commits 28 Branches 143 Tags 606 MiB
Commit Graph

111 Commits

Author SHA1 Message Date
David Rosa bdbc384de5 docs: Reduce the number of apparently broken links on github. 
- Updated 260+ links from ".html" to ".md" to reduce the number of issues
reported about hyperlinks not working when viewing docs on Github.
- Removed temporary workaround that suppressed all warnings reported
by sphinx build for every link ending in ".html".

Details:
The recent upgrade to recommonmark==0.5.0 supports auto-converting
".md" links to ".html" so that the resulting HTML output is correct.

Notice that links pointing to a heading i.e. "../filename.html#heading",
were not updated because recommonmark does not auto-convert them.
These links do not generate build warnings and do not cause any issues.
However, there are about ~100 such links that might still get misreported
as broken links.  This will be a follow-up issue.

Background:
docs: pip upgrade recommonmark and CommonMark #13013
docs: Allow .md links between doc pages #11719

Fixes #11087.
 2019-10-07 12:08:27 -07:00
Hemanth V. Alluri cfa6270080 docs: In api.md add the tools/ part before test-backend. 
In this section of the docs, two tools for testing openapi
documentation are mentioned. But for the second one, we
forgot to mention that the tool also resides in the tools/
folder (like the first one which explicitly mentions it).
This commit fixes that.
 2019-08-16 13:09:37 -07:00
Hemanth V. Alluri f280e9cf84 lib: Rename lib/api_test_helpers.py to openapi/python_examples.py 
This will make the contained code easier to find.
 2019-08-05 21:06:19 -07:00
Hemanth V. Alluri c90056bdb2 tools: Move check-swagger to check-openapi and make it executable. 2019-08-05 21:06:19 -07:00
David Rosa 871fd57f5e docs: Fix minor issues in api.md. 
With some tweaks for greater clarity by tabbott.
 2019-07-22 12:07:50 -07:00
Rishi Gupta 7afb44987e docs: Update tips for writing user documentation. 2019-07-20 14:39:15 -07:00
Tim Abbott c931e76cf2 docs: Rewrite docs on writing API documentation. 
This had gotten badly out of date, since it wasn't updated when we did
the big migration to the OpenAPI documentation system.

Fixes part of #12571.
 2019-07-19 18:00:01 -07:00
Rafid Aslam b52a7aed07 docs: Move tutorials/documenting-api-endpoints to documentation/api. 
Move docs/tutorials/documenting-api-endpoint.md to
docs/documentation/api.md.

This makes it easier to find when browsing the complete set of
materials on writing Zulip documentation.
 2019-05-30 11:12:25 -07:00
Tim Abbott b13add3eaf docs: Add missing index.rst for documentation/. 
Apparently I failed to commit this part of our documentation
migration.
 2019-05-29 17:54:02 -07:00
Tim Abbott 0330a5ed82 docs: Use bulleted list for user-facing subsystems. 
This makes it a bit more visually obvious that there are more than 3
total things expected below.
 2019-05-29 15:52:18 -07:00
Tim Abbott fa37c5cee1 docs: Extract a Writing Documentation top-level section. 
This should make this easier to find, and also makes "Subsystems" a
bit smaller of a catch-all.
 2019-05-29 15:52:11 -07:00