paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-04 14:03:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add README.md to zulip/docs to prevent reading on GitHub.

Browse Source 
This should help avoid confusing about broken links.

Tweaked by tabbott to fix formatting and the linter.
This commit is contained in:
Emilio Schadt
2018-04-23 20:28:14 -04:00
committed by Tim Abbott
parent e4ca6e947b
commit b6f5ea0fd2
2 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/README.md Normal file
View File

@@ -0,0 +1,6 @@
# Zulip markdown documentation hosted elsewhere
The markdown files in this directory ( /zulip/docs ) are not intended
to be read on GitHub. Instead, visit our
[ReadTheDocs](https://zulip.readthedocs.io/en/latest/index.html) to
read the Zulip documentation.

4
tools/linter_lib/custom_check.py
View File

@@ -743,9 +743,9 @@ def build_custom_checkers(by_lang):
{'pattern': '\[(?P<url>[^\]]+)\]\((?P=url)\)', {'pattern': '\[(?P<url>[^\]]+)\]\((?P=url)\)',
'description': 'Linkified markdown URLs should use cleaner <http://example.com> syntax.'}, 'description': 'Linkified markdown URLs should use cleaner <http://example.com> syntax.'},
{'pattern': 'https://zulip.readthedocs.io/en/latest/[a-zA-Z0-9]', {'pattern': 'https://zulip.readthedocs.io/en/latest/[a-zA-Z0-9]',
'exclude': ['docs/overview/contributing.md', 'docs/overview/readme.md'], 'exclude': ['docs/overview/contributing.md', 'docs/overview/readme.md', 'docs/README.md'],
'include_only': set(['docs/']), 'include_only': set(['docs/']),
'description': "Use relatve links (../foo/bar.html) to other documents in docs/", 'description': "Use relative links (../foo/bar.html) to other documents in docs/",
}, },
{'pattern': '\][(][^#h]', {'pattern': '\][(][^#h]',
'include_only': set(['README.md', 'CONTRIBUTING.md']), 'include_only': set(['README.md', 'CONTRIBUTING.md']),