Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zulip/docs/dev-overview.md

72 lines
3.2 KiB
Markdown
Raw Normal View History

docs: Move README.dev.md into ReadTheDocs. Fixes: #669.
2016-08-25 07:06:35 +02:00
# Development environment overview
Move development installations instructions to a separate file. This will make the core README.md file cleaner.
2015-11-04 05:57:54 +01:00
Improve first-time contributor docs. Fixes #747. Fixes #748. This updates README.dev.md to include clear, step-by-step instructions for setting up the Zulip dev environment Windows 10, OS X El Capitan, Ubuntu 14.04 Trusty, and Ubuntu 16.04 Xenial. It is aimed at first-time contributors. I tested these instructions multiple times on each of the target systems. Also added is a "trobleshooting and common errors" section which documents the most common errors contributors are likely to encounter during setup and how to fix them. Improvements based on feedback from @timabbott. - Fixes whitespace issues so linter will pass. - Updates memory requirement. - Re-orders so operating systems are listed alphabetically. - Updates headings to be clearer. - Updates and adds ToC entries for clarity. - Adds screen shot of Zulip dev environment running in browser. - Adds details about using dev environment, including about logging. - Misc other minor changes for clarity. - Adds a stub for docs/logging.md - Adds details about configuring Cygwin for native symlinks.
2016-05-05 01:16:31 +02:00
* [Development environment setup for first-time
contributors](#development-environment-setup-for-first-time-contributors)
* [Brief installation instructions for Vagrant development
environment](#brief-installation-instructions-for-vagrant-development-environment)
* [Installing on Ubuntu 14.04 Trusty without
Vagrant](#installing-on-ubuntu-1404-trusty-without-vagrant) (possibly more
convenient but more work to maintain/uninstall)
* [Installing manually on UNIX-based
platforms](#installing-manually-on-unix-based-platforms)
* [Using Docker (experimental)](#using-docker-experimental)
* [Using the Development Environment](#using-the-development-environment)
* [Running the test suite](#running-the-test-suite)
Move development installations instructions to a separate file. This will make the core README.md file cleaner.
2015-11-04 05:57:54 +01:00
Improve first-time contributor docs. Fixes #747. Fixes #748. This updates README.dev.md to include clear, step-by-step instructions for setting up the Zulip dev environment Windows 10, OS X El Capitan, Ubuntu 14.04 Trusty, and Ubuntu 16.04 Xenial. It is aimed at first-time contributors. I tested these instructions multiple times on each of the target systems. Also added is a "trobleshooting and common errors" section which documents the most common errors contributors are likely to encounter during setup and how to fix them. Improvements based on feedback from @timabbott. - Fixes whitespace issues so linter will pass. - Updates memory requirement. - Re-orders so operating systems are listed alphabetically. - Updates headings to be clearer. - Updates and adds ToC entries for clarity. - Adds screen shot of Zulip dev environment running in browser. - Adds details about using dev environment, including about logging. - Misc other minor changes for clarity. - Adds a stub for docs/logging.md - Adds details about configuring Cygwin for native symlinks.
2016-05-05 01:16:31 +02:00
Those who have installed Zulip before or are experienced at administering Linux
may wish to skip ahead to [Brief installation instructions for Vagrant
development environment](#brief-installation-instructions-for-vagrant-development-environment),
[Using Docker (experimental)](#using-docker-experimental), or [Installing
manually on UNIX-based platforms](#installing-manually-on-unix-based-platforms).
doc: Recommend avoiding Vagrant install on slow connections. Per #1508, the manual install process is better for the developer environment on slow connections.
2016-08-15 04:24:10 +02:00
If you have a slow network connection, you should probably avoid
installing Vagrant (which is large) and go through [the manual install
process](#installing-manually-on-unix-based-platforms) instead.
Improve first-time contributor docs. Fixes #747. Fixes #748. This updates README.dev.md to include clear, step-by-step instructions for setting up the Zulip dev environment Windows 10, OS X El Capitan, Ubuntu 14.04 Trusty, and Ubuntu 16.04 Xenial. It is aimed at first-time contributors. I tested these instructions multiple times on each of the target systems. Also added is a "trobleshooting and common errors" section which documents the most common errors contributors are likely to encounter during setup and how to fix them. Improvements based on feedback from @timabbott. - Fixes whitespace issues so linter will pass. - Updates memory requirement. - Re-orders so operating systems are listed alphabetically. - Updates headings to be clearer. - Updates and adds ToC entries for clarity. - Adds screen shot of Zulip dev environment running in browser. - Adds details about using dev environment, including about logging. - Misc other minor changes for clarity. - Adds a stub for docs/logging.md - Adds details about configuring Cygwin for native symlinks.
2016-05-05 01:16:31 +02:00
## Development environment setup for first-time contributors
Move and rearrange developer setup instructions. We aim to consolidate developer documentation on Read The Docs. As a start, this commit turns the first part of README.dev.md into a topic page within /docs/ , and links to it from the doc index. See #669.
2016-07-15 06:51:37 +02:00
See [the setup
guide](https://zulip.readthedocs.org/en/latest/dev-env-first-time-contributors.html).
Improve first-time contributor docs. Fixes #747. Fixes #748. This updates README.dev.md to include clear, step-by-step instructions for setting up the Zulip dev environment Windows 10, OS X El Capitan, Ubuntu 14.04 Trusty, and Ubuntu 16.04 Xenial. It is aimed at first-time contributors. I tested these instructions multiple times on each of the target systems. Also added is a "trobleshooting and common errors" section which documents the most common errors contributors are likely to encounter during setup and how to fix them. Improvements based on feedback from @timabbott. - Fixes whitespace issues so linter will pass. - Updates memory requirement. - Re-orders so operating systems are listed alphabetically. - Updates headings to be clearer. - Updates and adds ToC entries for clarity. - Adds screen shot of Zulip dev environment running in browser. - Adds details about using dev environment, including about logging. - Misc other minor changes for clarity. - Adds a stub for docs/logging.md - Adds details about configuring Cygwin for native symlinks.
2016-05-05 01:16:31 +02:00
Brief installation instructions for Vagrant development environment
Move development installations instructions to a separate file. This will make the core README.md file cleaner.
2015-11-04 05:57:54 +01:00
-------------
Move and rearrange vagrant instructions.
2016-07-15 06:58:43 +02:00
See [the Vagrant guide](https://zulip.readthedocs.org/en/latest/brief-install-vagrant-dev.html).
Vagrantfile: Add option for setting the port used on the host. This makes it easier to (for example) run a Zulip development environment on a host machine and sometimes run a Vagrant guest inside.
2016-07-07 23:47:59 +02:00
Improve first-time contributor docs. Fixes #747. Fixes #748. This updates README.dev.md to include clear, step-by-step instructions for setting up the Zulip dev environment Windows 10, OS X El Capitan, Ubuntu 14.04 Trusty, and Ubuntu 16.04 Xenial. It is aimed at first-time contributors. I tested these instructions multiple times on each of the target systems. Also added is a "trobleshooting and common errors" section which documents the most common errors contributors are likely to encounter during setup and how to fix them. Improvements based on feedback from @timabbott. - Fixes whitespace issues so linter will pass. - Updates memory requirement. - Re-orders so operating systems are listed alphabetically. - Updates headings to be clearer. - Updates and adds ToC entries for clarity. - Adds screen shot of Zulip dev environment running in browser. - Adds details about using dev environment, including about logging. - Misc other minor changes for clarity. - Adds a stub for docs/logging.md - Adds details about configuring Cygwin for native symlinks.
2016-05-05 01:16:31 +02:00
Installing on Ubuntu 14.04 Trusty without Vagrant
Move development installations instructions to a separate file. This will make the core README.md file cleaner.
2015-11-04 05:57:54 +01:00
----------------------------------
Split non-Vagrant Ubuntu install doc into topic page.
2016-07-15 20:01:07 +02:00
See [this guide](https://zulip.readthedocs.io/en/latest/install-ubuntu-without-vagrant-dev.html).
Split out generic UNIX developer install doc.
2016-07-15 20:05:08 +02:00
Improve first-time contributor docs. Fixes #747. Fixes #748. This updates README.dev.md to include clear, step-by-step instructions for setting up the Zulip dev environment Windows 10, OS X El Capitan, Ubuntu 14.04 Trusty, and Ubuntu 16.04 Xenial. It is aimed at first-time contributors. I tested these instructions multiple times on each of the target systems. Also added is a "trobleshooting and common errors" section which documents the most common errors contributors are likely to encounter during setup and how to fix them. Improvements based on feedback from @timabbott. - Fixes whitespace issues so linter will pass. - Updates memory requirement. - Re-orders so operating systems are listed alphabetically. - Updates headings to be clearer. - Updates and adds ToC entries for clarity. - Adds screen shot of Zulip dev environment running in browser. - Adds details about using dev environment, including about logging. - Misc other minor changes for clarity. - Adds a stub for docs/logging.md - Adds details about configuring Cygwin for native symlinks.
2016-05-05 01:16:31 +02:00
Installing manually on UNIX-based platforms
Move development installations instructions to a separate file. This will make the core README.md file cleaner.
2015-11-04 05:57:54 +01:00
-------
Improve first-time contributor docs. Fixes #747. Fixes #748. This updates README.dev.md to include clear, step-by-step instructions for setting up the Zulip dev environment Windows 10, OS X El Capitan, Ubuntu 14.04 Trusty, and Ubuntu 16.04 Xenial. It is aimed at first-time contributors. I tested these instructions multiple times on each of the target systems. Also added is a "trobleshooting and common errors" section which documents the most common errors contributors are likely to encounter during setup and how to fix them. Improvements based on feedback from @timabbott. - Fixes whitespace issues so linter will pass. - Updates memory requirement. - Re-orders so operating systems are listed alphabetically. - Updates headings to be clearer. - Updates and adds ToC entries for clarity. - Adds screen shot of Zulip dev environment running in browser. - Adds details about using dev environment, including about logging. - Misc other minor changes for clarity. - Adds a stub for docs/logging.md - Adds details about configuring Cygwin for native symlinks.
2016-05-05 01:16:31 +02:00
Split out generic UNIX developer install doc.
2016-07-15 20:05:08 +02:00
See [this guide](https://zulip.readthedocs.io/en/latest/install-generic-unix-dev.html).
Move by-hand proxy setup section closer to the actual instructions.
2016-04-13 18:02:44 +02:00
Mark Docker development instructions as experimental.
2016-04-30 01:15:14 +02:00
Using Docker (experimental)
---------------------------
Split out docker setup doc.
2016-07-15 19:47:25 +02:00
See [the Docker instructions](https://zulip.readthedocs.io/en/latest/install-docker-dev.html).
Add support for a development environment with Docker.
2015-12-12 14:17:30 +01:00
Split developer environment usage instructions into new page.
2016-07-15 20:43:09 +02:00
[using-dev]: https://zulip.readthedocs.io/en/latest/using-dev-environment.html
docs: Move README.dev.md into ReadTheDocs. Fixes: #669.
2016-08-25 07:06:35 +02:00
## Using the Development Environment
Expand documentation on how to use the development environment. * Reorganize to cover how to use the VM regardless of install process used. * Document exactly what you need to do in order to see your changes. * Remove the now-inaccurate documentation about flaky casper tests. * Point to the testing documentation.
2015-11-15 23:25:04 +01:00
Split developer environment usage instructions into new page.
2016-07-15 20:43:09 +02:00
See [this guide](https://zulip.readthedocs.io/en/latest/using-dev-environment.html).
Expand documentation on how to use the development environment. * Reorganize to cover how to use the VM regardless of install process used. * Document exactly what you need to do in order to see your changes. * Remove the now-inaccurate documentation about flaky casper tests. * Point to the testing documentation.
2015-11-15 23:25:04 +01:00
Reformat README.*.md to 70 characters uniformly. There are some stragglers, but this is better than the previous SOTW where line length was all over the place.
2016-03-21 04:40:10 +01:00
[django-runserver]: https://docs.djangoproject.com/en/1.8/ref/django-admin/#runserver-port-or-address-port
Update *.readthedocs.org => *.readthedocs.io. ReadTheDocs has moved their hosting of user project websites to the new readthedocs.io domain.
2016-04-30 01:00:06 +02:00
[new-feature-tutorial]: http://zulip.readthedocs.io/en/latest/new-feature-tutorial.html
[testing-docs]: http://zulip.readthedocs.io/en/latest/testing.html
Split out generic UNIX developer install doc.
2016-07-15 20:05:08 +02:00
The Zulip development environment is the recommended option for folks
interested in trying out Zulip. This is documented in [the developer
installation guide][dev-install].
Reformat README.*.md to 70 characters uniformly. There are some stragglers, but this is better than the previous SOTW where line length was all over the place.
2016-03-21 04:40:10 +01:00
Move and rearrange developer setup instructions. We aim to consolidate developer documentation on Read The Docs. As a start, this commit turns the first part of README.dev.md into a topic page within /docs/ , and links to it from the doc index. See #669.
2016-07-15 06:51:37 +02:00
[dev-install]: http://zulip.readthedocs.io/en/latest/dev-install-choices.html
Move and rearrange vagrant instructions.
2016-07-15 06:58:43 +02:00
[vagrant-dl]: https://www.vagrantup.com/downloads.html
[vagrant-lxc]: https://github.com/fgrehm/vagrant-lxc
[vbox-dl]: https://www.virtualbox.org/wiki/Downloads
[avoiding-sudo]: https://github.com/fgrehm/vagrant-lxc#avoiding-sudo-passwords
Split out docker setup doc.
2016-07-15 19:47:25 +02:00
Running the test suite
======================
De-duplicate testing docs. Addresses comment in #1218.
2016-08-03 01:25:11 +02:00
See [the developer testing guide](https://zulip.readthedocs.org/en/latest/testing.html).