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

18 Commits

Author SHA1 Message Date
Tim Abbott 0542c60466 docs: Do a general update pass on OpenAPI developer docs. 2020-06-20 19:06:07 -07:00
Tim Abbott 71078adc50 docs: Update URLs to use https://zulip.com. 
We're migrating to using the cleaner zulip.com domain, which involves
changing all of our links from ReadTheDocs and other places to point
to the cleaner URL.
 2020-06-08 18:10:45 -07:00
Sharif Naas 7e681c934c docs: Fix anchor link written in reference link syntax. 
This has been broken since it was added in a rewrite in July 2019 in
c931e76cf2. An incomplete fix was
made a few days later in 871fd57f5e.
 2020-06-01 18:31:05 -07:00
Tim Abbott 9b9aa23f6a docs: Fix path for API code markdown extension. 2020-05-19 11:11:41 -07:00
Steve Howell b3c9676baf docs: Use full path for zulip.yaml. 
Note that this section may actually be obsolete.
 2020-05-17 07:56:38 -04:00
Steve Howell cc9e6a54c0 doc: Fix tense for "Include". 2020-05-17 07:56:38 -04:00
Anders Kaseorg 8cdf2801f7 python: Convert more variable type annotations to Python 3.6 style. 
Signed-off-by: Anders Kaseorg <anders@zulip.com>
 2020-05-08 16:42:43 -07:00
Anders Kaseorg 7ff9b22500 docs: Convert many http URLs to https. 
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
 2020-03-26 21:35:32 -07:00
Tim Abbott fcd0a116b4 docs: Clarify how to test API endpoints. 2020-03-20 14:09:37 -07:00
Stefan Weil c220b971ae
docs: Fix some typos in documentation (most of them found and fixed by codespell). 
Signed-off-by: Stefan Weil <sw@weilnetz.de>
 2020-03-17 05:57:10 -07:00
Rodriq 8d466f6a25 docs: Update API docs usage example. 
This docs on writing API docs usage example hadn't been updated to use
generate_code_example(curl) after we introduced that feature.
 2020-01-22 12:00:10 -08:00
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
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