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

Docs: Added "connect the zulip upstream repo" to more places.

Browse Source
This commit is contained in:
gooca
2018-02-16 10:42:34 +00:00
committed by Tim Abbott
parent 70ccc30465
commit 64dac1bb2e
4 changed files with 65 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

65
docs/development/setup-advanced.md
View File

@@ -9,9 +9,13 @@ Contents:
## Installing directly on Ubuntu
Start by [cloning your fork of the zulip repository][zulip-rtd-git-cloning]:
Start by [cloning your fork of the Zulip repository][zulip-rtd-git-cloning]
and [connecting the Zulip upstream repository][zulip-rtd-git-connect]:
`git clone --config pull.rebase https://github.com/YOURUSERNAME/zulip.git`
```
git clone --config pull.rebase https://github.com/YOURUSERNAME/zulip.git
git remote add -f upstream https://github.com/zulip/zulip.git
```
If you'd like to install a Zulip development environment on a computer
that's already running Ubuntu 16.04 Xenial or Ubuntu 14.04 Trusty, you
@@ -63,9 +67,13 @@ Install the following non-Python dependencies:
#### Using the official Ubuntu repositories, PGroonga PPA and `tsearch-extras` deb package:
Start by [cloning your fork of the zulip repository][zulip-rtd-git-cloning]:
Start by [cloning your fork of the Zulip repository][zulip-rtd-git-cloning]
and [connecting the Zulip upstream repository][zulip-rtd-git-connect]:
`git clone --config pull.rebase https://github.com/YOURUSERNAME/zulip.git`
```
git clone --config pull.rebase https://github.com/YOURUSERNAME/zulip.git
git remote add -f upstream https://github.com/zulip/zulip.git
```
```
sudo apt-get install closure-compiler libfreetype6-dev libffi-dev \
@@ -124,9 +132,13 @@ Now continue with the [All Systems](#all-systems) instructions below.
[zulip-ppa]: https://launchpad.net/~tabbott/+archive/ubuntu/zulip/+packages
Start by [cloning your fork of the zulip repository][zulip-rtd-git-cloning]:
Start by [cloning your fork of the Zulip repository][zulip-rtd-git-cloning]
and [connecting the Zulip upstream repository][zulip-rtd-git-connect]:
`git clone --config pull.rebase https://github.com/YOURUSERNAME/zulip.git`
```
git clone --config pull.rebase https://github.com/YOURUSERNAME/zulip.git
git remote add -f upstream https://github.com/zulip/zulip.git
```
```
sudo add-apt-repository ppa:tabbott/zulip
@@ -145,9 +157,13 @@ Now continue with the [All Systems](#all-systems) instructions below.
These instructions are experimental and may have bugs; patches
welcome!
Start by [cloning your fork of the zulip repository][zulip-rtd-git-cloning]:
Start by [cloning your fork of the Zulip repository][zulip-rtd-git-cloning]
and [connecting the Zulip upstream repository][zulip-rtd-git-connect]:
`git clone --config pull.rebase https://github.com/YOURUSERNAME/zulip.git`
```
git clone --config pull.rebase https://github.com/YOURUSERNAME/zulip.git
git remote add -f upstream https://github.com/zulip/zulip.git
```
```
sudo dnf install libffi-devel memcached rabbitmq-server \
@@ -163,9 +179,13 @@ Now continue with the [Common to Fedora/CentOS](#common-to-fedora-centos-instruc
These instructions are experimental and may have bugs; patches
welcome!
Start by [cloning your fork of the zulip repository][zulip-rtd-git-cloning]:
Start by [cloning your fork of the Zulip repository][zulip-rtd-git-cloning]
and [connecting the Zulip upstream repository][zulip-rtd-git-connect]:
`git clone --config pull.rebase https://github.com/YOURUSERNAME/zulip.git`
```
git clone --config pull.rebase https://github.com/YOURUSERNAME/zulip.git
git remote add -f upstream https://github.com/zulip/zulip.git
```
```
# Add user zulip to the system (not necessary if you configured zulip
@@ -222,9 +242,13 @@ Now continue with the [Common to Fedora/CentOS](#common-to-fedora-centos-instruc
These instructions are experimental and may have bugs; patches
welcome!
Start by [cloning your fork of the zulip repository][zulip-rtd-git-cloning]:
Start by [cloning your fork of the Zulip repository][zulip-rtd-git-cloning]
and [connecting the Zulip upstream repository][zulip-rtd-git-connect]:
`git clone --config pull.rebase https://github.com/YOURUSERNAME/zulip.git`
```
git clone --config pull.rebase https://github.com/YOURUSERNAME/zulip.git
git remote add -f upstream https://github.com/zulip/zulip.git
```
```
doas pkg_add sudo bash gcc postgresql-server redis rabbitmq \
@@ -257,9 +281,13 @@ Finally continue with the [All Systems](#all-systems) instructions below.
### Common to Fedora/CentOS instructions
Start by [cloning your fork of the zulip repository][zulip-rtd-git-cloning]:
Start by [cloning your fork of the Zulip repository][zulip-rtd-git-cloning]
and [connecting the Zulip upstream repository][zulip-rtd-git-connect]:
`git clone --config pull.rebase https://github.com/YOURUSERNAME/zulip.git`
```
git clone --config pull.rebase https://github.com/YOURUSERNAME/zulip.git
git remote add -f upstream https://github.com/zulip/zulip.git
```
```
# Build and install postgres tsearch-extras module
@@ -426,9 +454,13 @@ how to use zulip-cloud9 package.
## Using Docker (experimental)
Start by [cloning your fork of the zulip repository][zulip-rtd-git-cloning]:
Start by [cloning your fork of the Zulip repository][zulip-rtd-git-cloning]
and [connecting the Zulip upstream repository][zulip-rtd-git-connect]:
`git clone --config pull.rebase https://github.com/YOURUSERNAME/zulip.git`
```
git clone --config pull.rebase https://github.com/YOURUSERNAME/zulip.git
git remote add -f upstream https://github.com/zulip/zulip.git
```
The docker instructions for development are experimental, so they may
have bugs. If you try them and run into any issues, please report
@@ -525,3 +557,4 @@ the Vagrant workflow and less documented; please contribute to this
guide and the Docker tooling if you are using Docker to develop Zulip!
[zulip-rtd-git-cloning]: ../git/cloning.html#step-1b-clone-to-your-machine
[zulip-rtd-git-connect]: ../git/cloning.html#step-1c-connect-your-fork-to-zulip-upstream

4
docs/development/setup-vagrant.md
View File

@@ -276,10 +276,12 @@ Now you are ready for [Step 2: Get Zulip Code.](#step-2-get-zulip-code)
2. Open Terminal (macOS/Ubuntu) or Git BASH (Windows; must
**run as an Administrator**).
3. In Terminal/Git BASH,
[clone your fork of the zulip repository](../git/cloning.html#step-1b-clone-to-your-machine):
[clone your fork of the Zulip repository](../git/cloning.html#step-1b-clone-to-your-machine)
and [connect the Zulip upstream repository](../git/cloning.html#step-1c-connect-your-fork-to-zulip-upstream):
```
git clone --config pull.rebase git@github.com:YOURUSERNAME/zulip.git
git remote add -f upstream https://github.com/zulip/zulip.git
```
This will create a 'zulip' directory and download the Zulip code into it.

2
docs/git/cloning.md
View File

@@ -79,7 +79,7 @@ If your client hasn't automatically configured a remote for zulip/zulip, you'll
need to with:
```
$ git remote add upstream https://github.com/zulip/zulip.git
$ git remote add -f upstream https://github.com/zulip/zulip.git
```
Finally, confirm that the new remote repository, upstream, has been configured:

12
docs/testing/testing.md
View File

@@ -67,6 +67,18 @@ if you're working on new database migrations. To do this, run:
above. Afterwards, re-run the `init*-db` and the
`do-destroy-rebuild*-database` scripts.
- Or, when running the test suite, if you get an error involving Git that looks like this:
```
commit_messages| An error occurred while executing '/usr/bin/git rev-list --max-count=-1 upstream/master..HEAD': b"fatal: ambiguous argument 'upstream/master..HEAD': unknown revision or path not in the working tree.\nUse '--' to separate paths from revisions, like this:\n'git <command> [<revision>...] -- [<file>...]'"
```
... then you may need to connect the Zulip upstream repository with the following command:
```
git remote add -f upstream https://github.com/zulip/zulip.git
```
- When building the development environment using Vagrant and the LXC
provider, if you encounter permissions errors, you may need to
`chown -R 1000:$(whoami) /path/to/zulip` on the host before running