zulip/tools
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
..
ci install, provision: Treat all nonzero exit codes as failure, not just 1. 2019-07-19 11:22:11 -07:00
circleci minify-js: Remove; everything has been migrated to Webpack. 2019-07-03 13:58:21 -07:00
documentation_crawler documentation_crawler: Stop treating all portico URLs as external. 2019-07-18 11:56:15 -07:00
droplets droplets: Update snapshot id. 2019-06-14 15:49:56 -07:00
i18n i18n: Move static/locale back to locale. 2019-07-02 14:57:55 -07:00
lib provision_inner: Remove unused lsb_release run. 2019-07-19 16:36:11 -07:00
linter_lib docs: Rewrite docs on writing API documentation. 2019-07-19 18:00:01 -07:00
setup generate_zulip_bots_static_files: Write to static, not STATIC_ROOT. 2019-07-19 11:33:08 -07:00
test-install minify-js: Remove; everything has been migrated to Webpack. 2019-07-03 13:58:21 -07:00
tests templates: Use upstream Handlebars partials syntax. 2019-07-12 21:11:14 -07:00
zulint lint: Make `--fix` a default arg for zulint. 2019-07-03 14:57:31 -07:00
zulip-export tools: Remove unused imports. 2019-02-02 17:10:31 -08:00
README.md
__init__.py
build-docs build-docs: Fix shellcheck warnings. 2018-10-17 17:38:56 -07:00
build-release-tarball i18n: Move static/locale back to locale. 2019-07-02 14:57:55 -07:00
cache-zulip-git-version version: Fail gracefully if git describe cannot get version. 2019-06-14 13:47:27 +05:30
check-capitalization i18n: Move static/locale back to locale. 2019-07-02 14:57:55 -07:00
check-frontend-i18n i18n: Move static/locale back to locale. 2019-07-02 14:57:55 -07:00
check-issue-labels lint: Fix code that evaded our lint checks for string % non-tuple. 2019-04-23 15:21:37 -07:00
check-provision tools: Extract get_provisioning_status check logic. 2019-06-23 21:55:02 -07:00
check-swagger
check-templates check-templates: Add fix option to tools/check_templates. 2019-07-19 11:12:11 -07:00
clean-branches clean-branches: Fix shellcheck warnings. 2018-10-17 17:38:56 -07:00
clean-repo
commit-message-lint Use #!/usr/bin/env for bash shebangs. 2018-12-17 17:21:08 -08:00
commit-msg Use #!/usr/bin/env for bash shebangs. 2018-12-17 17:21:08 -08:00
conf.ini-template
coveragerc coveragerc: Omit blub. 2019-05-29 15:04:47 -07:00
create-test-api-docs tools: Remove unused imports. 2019-02-02 17:10:31 -08:00
deploy-branch Use #!/usr/bin/env for bash shebangs. 2018-12-17 17:21:08 -08:00
diagnose docs: Add documentation for `if False` mypy pattern in scripts. 2018-12-17 11:12:53 -08:00
django-template-graph django-template-graph: Fix shellcheck warnings. 2018-10-17 17:38:56 -07:00
do-destroy-rebuild-database scripts: Always use ON_ERROR_STOP=1 when running psql. 2019-04-22 14:54:19 -07:00
do-destroy-rebuild-test-database do-destroy-rebuild-test-database: Fix shellcheck warnings. 2018-08-03 09:15:26 -07:00
documentation.vnufilter test-documentation: Validate HTML with vnu.jar. 2019-06-27 14:53:21 -07:00
fetch-pull-request Use #!/usr/bin/env for bash shebangs. 2018-12-17 17:21:08 -08:00
fetch-rebase-pull-request Use #!/usr/bin/env for bash shebangs. 2018-12-17 17:21:08 -08:00
find-add-class tools: Remove unused imports. 2019-02-02 17:10:31 -08:00
find-unused-css Use #!/usr/bin/env for bash shebangs. 2018-12-17 17:21:08 -08:00
get-handlebar-vars Enable pycodestyle W605 (invalid escape sequence). 2018-07-03 16:54:46 +02:00
html-grep templates: Rename *.handlebars ↦ *.hbs and - ↦ _. 2019-07-12 21:11:03 -07:00
inline-email-css emails: Fix duplicate <html> blocks in missed-message emails. 2019-01-11 14:23:30 -08:00
js-dep-visualizer.py tools: Add TypeScript to the dependency visualizer. 2019-04-12 11:14:42 -07:00
lint check-templates: Add fix option to tools/check_templates. 2019-07-19 11:12:11 -07:00
list-outdated-packages tools: Add tool for listing outdated pip packages. 2018-05-24 15:16:02 -07:00
pre-commit lint: Add --skip arg to replace --no-gitlint/mypy. 2019-06-18 11:32:04 -07:00
pretty-print-html lint: Fix code that evaded our lint checks for string % non-tuple. 2019-04-23 15:21:37 -07:00
provision install, provision: Treat all nonzero exit codes as failure, not just 1. 2019-07-19 11:22:11 -07:00
push-to-pull-request Use #!/usr/bin/env for bash shebangs. 2018-12-17 17:21:08 -08:00
release-tarball-exclude.txt tests: Move zerver/fixtures to zerver/tests/fixtures for clarity. 2018-04-19 21:50:17 -07:00
renumber-migrations tools: Only files starting with same migration number conflict. 2018-07-10 21:09:34 +05:30
replacer zulint: Move lister.py to tools/zulint. 2018-08-04 19:53:53 -07:00
reset-to-pull-request Use #!/usr/bin/env for bash shebangs. 2018-12-17 17:21:08 -08:00
review tools/review: Don’t pretend to emulate shell=True either. 2018-07-30 22:39:08 -07:00
run-dev.py webpack: Use handlebars-loader to handle frontend templates. 2019-07-02 16:23:29 -07:00
run-mypy tools: Extract get_provisioning_status check logic. 2019-06-23 21:55:02 -07:00
setup-git-repo Use #!/usr/bin/env for bash shebangs. 2018-12-17 17:21:08 -08:00
show-profile-results
stop-run-dev
test-all lint: Use --groups to specify specific groups to run. 2019-06-23 22:23:15 -07:00
test-api tools: Extract get_provisioning_status check logic. 2019-06-23 21:55:02 -07:00
test-backend test_fixtures: Add logic for removing stale test directories. 2019-07-12 17:42:18 -07:00
test-documentation test-documentation: Validate HTML with vnu.jar. 2019-06-27 14:53:21 -07:00
test-emoji-name-scripts test-emoji-name-scripts: Avoid hardcoded paths in /var/tmp. 2019-01-15 16:05:50 -08:00
test-help-documentation test-help-documentation: Bind vnu.jar to 127.0.0.1. 2019-06-28 18:18:29 -07:00
test-js-with-casper
test-js-with-node webpack: Remove resolve.modules override. 2019-07-02 16:38:26 -07:00
test-locked-requirements tools: Remove unused imports. 2019-02-02 17:10:31 -08:00
test-migrations requirements: Upgrade django-otp from 0.5.2 to 0.6.0. 2019-07-07 22:28:54 -07:00
test-queue-worker-reload test-queue-worker-reload: Use a pipe rather than polling a log file. 2019-01-15 16:00:48 -08:00
test-run-dev test-run-dev: Use a pipe rather than polling a log file. 2019-01-15 16:00:48 -08:00
test-tools
update-authors-json update-authors-json: Write to static, not STATIC_ROOT. 2019-07-19 11:33:08 -07:00
update-locked-requirements update-locked-requirements: Fix shellcheck warnings. 2018-08-03 09:15:27 -07:00
update-prod-static storage: Move the staticfiles.json hack to ZulipStorage. 2019-07-19 11:47:51 -07:00
update-zuliprc-api-field tools: Add tool to update API field of local zuliprc file. 2019-07-17 16:00:21 -07:00
upgrade-python-dependencies tools: Avoid upgrading stripe automatically. 2019-05-17 11:36:35 -07:00
webpack tools/webpack: Don’t import Django. 2019-07-03 14:52:11 -07:00
webpack-helpers.ts third: Upgrade spectrum-colorpicker to 1.8.0 from NPM. 2019-07-10 10:07:34 -07:00
webpack.assets.json bundles: Rename commons.js to common.js. 2019-07-03 15:03:22 -07:00
webpack.config.ts generate-custom-icon-webfont: Replace with webpack webfonts-loader. 2019-07-18 12:00:00 -07:00
zanitizer docs: Avoid hardcoded /tmp paths in miscellaneous documentation. 2019-01-15 16:16:12 -08:00
zanitizer_config.pm.sample zanitizer_config.pm.sample: keep_file → scrub_filename 2018-09-23 20:42:27 -07:00

README.md

This directory contains scripts that are used in building, managing, testing, and other forms of work in a Zulip development environment. Note that tools that are also useful in production belong in scripts/ or should be Django management commands.

For more details, see https://zulip.readthedocs.io/en/latest/overview/directory-structure.html.