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

docs: Add ".ts" support in docs and configuration.

Browse Source 
Add references to TypeScript in documentation where appropriate, such
as in example bash commands and discussions of the file structure.
Add a new section to the Reading List with TypeScript resources.
Also update `.editorconfig` to support ".ts" files.

Fix part of #12000.
This commit is contained in:
Marco Burstein
2019-03-28 12:55:05 -07:00
committed by Tim Abbott
parent ce7d2fde70
commit ae5496020b
9 changed files with 42 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -114,10 +114,10 @@ Realm setting, in `test_realm.py`).
### Frontend changes
**JavaScript:** Zulip's JavaScript is located in the directory
`static/js/`. The exact files you may need to change depend on your
feature. If you've added a new event that is sent to clients, be sure to
add a handler for it in `static/js/server_events_dispatch.js`.
**JavaScript/TypeScript:** Zulip's JavaScript and TypeScript sources are
located in the directory `static/js/`. The exact files you may need to change
depend on your feature. If you've added a new event that is sent to clients,
be sure to add a handler for it in `static/js/server_events_dispatch.js`.
**CSS:** The primary CSS file is `static/styles/zulip.css`. If your new
feature requires UI changes, you may need to add additional CSS to this
@@ -129,7 +129,7 @@ Handlebars templates located in `static/templates`. Templates are
precompiled as part of the build/deploy process.
Zulip is fully internationalized, so when writing both HTML templates
or JavaScript code that generates user-facing strings, be sure to
or JavaScript/TypeScript code that generates user-facing strings, be sure to
[tag those strings for translation](../translating/translating.html).
**Testing:** There are two types of frontend tests: node-based unit

14
docs/tutorials/reading-list.md
View File

@@ -140,6 +140,20 @@ Some titles have been shortened for organizational purposes.
[TypeScript vs. CoffeeScript vs. ES6]: http://www.slideshare.net/NeilGreen1/type-script-vs-coffeescript-vs-es6
## TypeScript
*Tutorial* - [TypeScript handbook section on base types][typescript-handbook]
[typescript-handbook]: https://www.typescriptlang.org/docs/handbook/basic-types.html
*Book* - [TypeScript Deep Dive][]
[TypeScript Deep Dive]: https://basarat.gitbooks.io/typescript/
*Guide* - [TypeScript Declaration Files Introduction][]
[TypeScript Declaration Files Introduction]: https://www.typescriptlang.org/docs/handbook/declaration-files/introduction.html
## Git/Version Control Systems (VCS)
You may want to take a look first at our [Git and GitHub guide][].