From f6c4e46afebafdbfca8d83040e5d843212ca6245 Mon Sep 17 00:00:00 2001 From: Tim Abbott Date: Wed, 24 Aug 2016 22:06:35 -0700 Subject: [PATCH] docs: Move README.dev.md into ReadTheDocs. Fixes: #669. --- README.md | 2 +- README.dev.md => docs/dev-overview.md | 6 ++---- docs/index.rst | 1 + 3 files changed, 4 insertions(+), 5 deletions(-) rename README.dev.md => docs/dev-overview.md (96%) diff --git a/README.md b/README.md index 877ff3536e..1c912284d8 100644 --- a/README.md +++ b/README.md @@ -104,7 +104,7 @@ PostgreSQL extension][tsearch], as separate repos. contributing! [cla]: https://opensource.dropbox.com/cla/ -[dev-install]: https://github.com/zulip/zulip/blob/master/README.dev.md +[dev-install]: https://zulip.readthedocs.io/en/latest/dev-overview.html [doc]: https://zulip.readthedocs.io/ [doc-commit-style]: http://zulip.readthedocs.io/en/latest/code-style.html#commit-messages [doc-dirstruct]: http://zulip.readthedocs.io/en/latest/directory-structure.html diff --git a/README.dev.md b/docs/dev-overview.md similarity index 96% rename from README.dev.md rename to docs/dev-overview.md index d4b143f5b2..7d32fc1dc7 100644 --- a/README.dev.md +++ b/docs/dev-overview.md @@ -1,5 +1,4 @@ - -Installing the Zulip Development environment +# Development environment overview * [Development environment setup for first-time contributors](#development-environment-setup-for-first-time-contributors) @@ -49,8 +48,7 @@ See [the Docker instructions](https://zulip.readthedocs.io/en/latest/install-doc [using-dev]: https://zulip.readthedocs.io/en/latest/using-dev-environment.html -Using the Development Environment -================================= +## Using the Development Environment See [this guide](https://zulip.readthedocs.io/en/latest/using-dev-environment.html). diff --git a/docs/index.rst b/docs/index.rst index c95a5a4438..ab8649d39d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -62,6 +62,7 @@ Contents: :maxdepth: 2 :caption: Installation for developers + dev-overview dev-env-first-time-contributors brief-install-vagrant-dev install-ubuntu-without-vagrant-dev