mirror of https://github.com/zulip/zulip.git
docs: Add spaces to “check out”, “log in”, “set up”, “sign up” as verbs.
“Checkout”, “login”, “setup”, and “signup” are nouns, not verbs. Signed-off-by: Anders Kaseorg <anders@zulip.com>
This commit is contained in:
parent
598601e8fc
commit
dd48dbd912
|
@ -7,14 +7,14 @@ jobs:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout repository
|
- name: Check out repository
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v2
|
||||||
with:
|
with:
|
||||||
# We must fetch at least the immediate parents so that if this is
|
# We must fetch at least the immediate parents so that if this is
|
||||||
# a pull request then we can checkout the head.
|
# a pull request then we can check out the head.
|
||||||
fetch-depth: 2
|
fetch-depth: 2
|
||||||
|
|
||||||
# If this run was triggered by a pull request event, then checkout
|
# If this run was triggered by a pull request event, then check out
|
||||||
# the head of the pull request instead of the merge commit.
|
# the head of the pull request instead of the merge commit.
|
||||||
- run: git checkout HEAD^2
|
- run: git checkout HEAD^2
|
||||||
if: ${{ github.event_name == 'pull_request' }}
|
if: ${{ github.event_name == 'pull_request' }}
|
||||||
|
|
|
@ -1216,7 +1216,7 @@ class StripeTest(StripeTestCase):
|
||||||
@mock_stripe()
|
@mock_stripe()
|
||||||
def test_payment_method_string(self, *mocks: Mock) -> None:
|
def test_payment_method_string(self, *mocks: Mock) -> None:
|
||||||
pass
|
pass
|
||||||
# If you signup with a card, we should show your card as the payment method
|
# If you sign up with a card, we should show your card as the payment method
|
||||||
# Already tested in test_initial_upgrade
|
# Already tested in test_initial_upgrade
|
||||||
|
|
||||||
# If you pay by invoice, your payment method should be
|
# If you pay by invoice, your payment method should be
|
||||||
|
@ -1228,7 +1228,7 @@ class StripeTest(StripeTestCase):
|
||||||
# stripe_customer = stripe_get_customer(Customer.objects.get(realm=user.realm).stripe_customer_id)
|
# stripe_customer = stripe_get_customer(Customer.objects.get(realm=user.realm).stripe_customer_id)
|
||||||
# self.assertEqual('Billed by invoice', payment_method_string(stripe_customer))
|
# self.assertEqual('Billed by invoice', payment_method_string(stripe_customer))
|
||||||
|
|
||||||
# If you signup with a card and then downgrade, we still have your
|
# If you sign up with a card and then downgrade, we still have your
|
||||||
# card on file, and should show it
|
# card on file, and should show it
|
||||||
# TODO
|
# TODO
|
||||||
|
|
||||||
|
|
|
@ -60,7 +60,7 @@ See also [fixing commits][fix-commit]
|
||||||
- `git add foo.py bar.py`: add `foo.py` AND `bar.py` to the staging area
|
- `git add foo.py bar.py`: add `foo.py` AND `bar.py` to the staging area
|
||||||
- `git add -u`: Adds all tracked files to the staging area.
|
- `git add -u`: Adds all tracked files to the staging area.
|
||||||
- checkout
|
- checkout
|
||||||
- `git checkout -b new-branch-name`: create branch `new-branch-name` and switch/checkout to that new branch
|
- `git checkout -b new-branch-name`: create branch `new-branch-name` and switch to/check out that new branch
|
||||||
- `git checkout master`: switch to your `master` branch
|
- `git checkout master`: switch to your `master` branch
|
||||||
- `git checkout old-branch-name`: switch to an existing branch `old-branch-name`
|
- `git checkout old-branch-name`: switch to an existing branch `old-branch-name`
|
||||||
- commit
|
- commit
|
||||||
|
|
|
@ -8,7 +8,7 @@ accepted. We also recommend you work on feature branches.
|
||||||
|
|
||||||
## Step 1a: Create your fork
|
## Step 1a: Create your fork
|
||||||
|
|
||||||
The following steps you'll only need to do the first time you setup a machine
|
The following steps you'll only need to do the first time you set up a machine
|
||||||
for contributing to a given Zulip project. You'll need to repeat the steps for
|
for contributing to a given Zulip project. You'll need to repeat the steps for
|
||||||
any additional Zulip projects ([list][github-zulip]) that you work on.
|
any additional Zulip projects ([list][github-zulip]) that you work on.
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ $ git remote add <username> https://github.com/<username>/zulip.git
|
||||||
$ git fetch <username>
|
$ git fetch <username>
|
||||||
```
|
```
|
||||||
|
|
||||||
Now you can checkout their branch just like you would any other. You can name
|
Now you can check out their branch just like you would any other. You can name
|
||||||
the branch anything you want, but using both the username and branch name will
|
the branch anything you want, but using both the username and branch name will
|
||||||
help you keep things organized.
|
help you keep things organized.
|
||||||
|
|
||||||
|
@ -24,9 +24,9 @@ You can choose to rename the branch if you prefer:
|
||||||
git checkout -b <custombranchname> <username>/<branchname>
|
git checkout -b <custombranchname> <username>/<branchname>
|
||||||
```
|
```
|
||||||
|
|
||||||
## Checkout a pull request locally
|
## Check out a pull request locally
|
||||||
|
|
||||||
Just as you can checkout any user's branch locally, you can also checkout any
|
Just as you can check out any user's branch locally, you can also check out any
|
||||||
pull request locally. GitHub provides a special syntax
|
pull request locally. GitHub provides a special syntax
|
||||||
([details][github-help-co-pr-locally]) for this since pull requests are
|
([details][github-help-co-pr-locally]) for this since pull requests are
|
||||||
specific to GitHub rather than Git.
|
specific to GitHub rather than Git.
|
||||||
|
|
|
@ -115,7 +115,7 @@ your pull request title with [WIP] if it is a [work-in-progress][wip-prs].
|
||||||
If your pull request has an effect on the visuals of a component, you might want
|
If your pull request has an effect on the visuals of a component, you might want
|
||||||
to include a screenshot of this change or a GIF of the interaction in your first
|
to include a screenshot of this change or a GIF of the interaction in your first
|
||||||
comment. This will allow reviewers to comment on your changes without having to
|
comment. This will allow reviewers to comment on your changes without having to
|
||||||
checkout your branch; you can find a list of tools you can use for this over
|
check out your branch; you can find a list of tools you can use for this over
|
||||||
[here][screenshots-gifs].
|
[here][screenshots-gifs].
|
||||||
|
|
||||||
When ready, click the green **Create pull request** to submit the pull request.
|
When ready, click the green **Create pull request** to submit the pull request.
|
||||||
|
|
|
@ -57,7 +57,7 @@ configured in the step above:
|
||||||
$ git fetch upstream
|
$ git fetch upstream
|
||||||
```
|
```
|
||||||
|
|
||||||
Next, checkout your `master` branch and [rebase][gitbook-git-rebase] it on top
|
Next, check out your `master` branch and [rebase][gitbook-git-rebase] it on top
|
||||||
of `upstream/master`:
|
of `upstream/master`:
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
|
@ -163,7 +163,7 @@ Deleting local branch review-original-5156 (was 5a1e982)
|
||||||
## Merge conflict on yarn.lock file
|
## Merge conflict on yarn.lock file
|
||||||
|
|
||||||
If there is a merge conflict on yarn.lock, yarn should be run to
|
If there is a merge conflict on yarn.lock, yarn should be run to
|
||||||
regenerate the file. *Important* don't delete the yarn.lock file. Checkout the
|
regenerate the file. *Important* don't delete the yarn.lock file. Check out the
|
||||||
latest one from origin/master so that yarn knows the previous asset versions.
|
latest one from origin/master so that yarn knows the previous asset versions.
|
||||||
|
|
||||||
Run the following commands
|
Run the following commands
|
||||||
|
@ -175,5 +175,5 @@ git rebase --continue
|
||||||
```
|
```
|
||||||
|
|
||||||
[github-zulip-zulip]: https://github.com/zulip/zulip/
|
[github-zulip-zulip]: https://github.com/zulip/zulip/
|
||||||
[zulip-git-guide-fetch-pr]: ../git/collaborate.html#checkout-a-pull-request-locally
|
[zulip-git-guide-fetch-pr]: ../git/collaborate.html#check-out-a-pull-request-locally
|
||||||
[zulip-git-guide-ci]: ../git/cloning.html#step-3-configure-continuous-integration-for-your-fork
|
[zulip-git-guide-ci]: ../git/cloning.html#step-3-configure-continuous-integration-for-your-fork
|
||||||
|
|
|
@ -185,7 +185,7 @@ will be stored in that directory and you'll want to back it up.
|
||||||
|
|
||||||
* Your Zulip configuration including secrets from `/etc/zulip/`.
|
* Your Zulip configuration including secrets from `/etc/zulip/`.
|
||||||
E.g. if you lose the value of `secret_key`, all users will need to
|
E.g. if you lose the value of `secret_key`, all users will need to
|
||||||
login again when you set up a replacement server since you won't be
|
log in again when you set up a replacement server since you won't be
|
||||||
able to verify their cookies. If you lose `avatar_salt`, any
|
able to verify their cookies. If you lose `avatar_salt`, any
|
||||||
user-uploaded avatars will need to be re-uploaded (since avatar
|
user-uploaded avatars will need to be re-uploaded (since avatar
|
||||||
filenames are computed using a hash of `avatar_salt` and user's
|
filenames are computed using a hash of `avatar_salt` and user's
|
||||||
|
@ -266,7 +266,7 @@ preventing all accounts from logging in or accessing the API. This is
|
||||||
preferred for environments like Zulip Cloud where you might want to
|
preferred for environments like Zulip Cloud where you might want to
|
||||||
export a single organization without disrupting any other users, and
|
export a single organization without disrupting any other users, and
|
||||||
the intent is to move hosting of the organization (and forcing users
|
the intent is to move hosting of the organization (and forcing users
|
||||||
to re-login would be required as part of the hosting migration
|
to re-log in would be required as part of the hosting migration
|
||||||
anyway).
|
anyway).
|
||||||
|
|
||||||
We include both options in the instructions below, commented out so
|
We include both options in the instructions below, commented out so
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
The following list documents different screenshoting & GIF-making techniques and
|
The following list documents different screenshoting & GIF-making techniques and
|
||||||
free software. We encourage you to make use of these when making front-end pull
|
free software. We encourage you to make use of these when making front-end pull
|
||||||
requests, as other contributors can see the changes you have made without having
|
requests, as other contributors can see the changes you have made without having
|
||||||
to checkout your branch.
|
to check out your branch.
|
||||||
|
|
||||||
## Screenshot tools by platform
|
## Screenshot tools by platform
|
||||||
### Browser
|
### Browser
|
||||||
|
|
|
@ -151,7 +151,7 @@ if not os.path.exists(os.path.join(deploy_path, "zproject/prod_settings.py")):
|
||||||
subprocess.check_call([os.path.join(deploy_path, "scripts", "lib", "create-production-venv"),
|
subprocess.check_call([os.path.join(deploy_path, "scripts", "lib", "create-production-venv"),
|
||||||
deploy_path])
|
deploy_path])
|
||||||
|
|
||||||
# Setup the thumbor venv
|
# Set up the thumbor venv
|
||||||
subprocess.check_call([os.path.join(deploy_path, "scripts", "lib", "create-thumbor-venv"),
|
subprocess.check_call([os.path.join(deploy_path, "scripts", "lib", "create-thumbor-venv"),
|
||||||
deploy_path])
|
deploy_path])
|
||||||
|
|
||||||
|
|
|
@ -163,7 +163,7 @@ exports.close_overlay = function (name) {
|
||||||
$(".header").attr("aria-hidden", "false");
|
$(".header").attr("aria-hidden", "false");
|
||||||
|
|
||||||
if (!close_handler) {
|
if (!close_handler) {
|
||||||
blueslip.error("Overlay close handler for " + name + " not properly setup.");
|
blueslip.error("Overlay close handler for " + name + " not properly set up.");
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -40,7 +40,7 @@ mirror script instead of using Webathena.</p>
|
||||||
<h4>Mirroring without a BarnOwl session</h4>
|
<h4>Mirroring without a BarnOwl session</h4>
|
||||||
|
|
||||||
<p>If you are not already running a screen/tmux for BarnOwl, you
|
<p>If you are not already running a screen/tmux for BarnOwl, you
|
||||||
can setup a screen session to run the Zephyr mirroring script by
|
can set up a screen session to run the Zephyr mirroring script by
|
||||||
running the following on a dialup such
|
running the following on a dialup such
|
||||||
as <a href="https://linerva.mit.edu">linerva.mit.edu</a>:</p>
|
as <a href="https://linerva.mit.edu">linerva.mit.edu</a>:</p>
|
||||||
|
|
||||||
|
@ -56,7 +56,7 @@ mirror script instead of using Webathena.</p>
|
||||||
session, and use `/mit/kchen/bin/cont-renew-notify` to continually
|
session, and use `/mit/kchen/bin/cont-renew-notify` to continually
|
||||||
renew your Kerberos tickets for up to a week; each week, it will
|
renew your Kerberos tickets for up to a week; each week, it will
|
||||||
send you a Zephyr/Zulip letting you know that you need to renew
|
send you a Zephyr/Zulip letting you know that you need to renew
|
||||||
your tickets. To do so, log in to the server that you setup the
|
your tickets. To do so, log in to the server that you set up the
|
||||||
screen session on and use the following procedure:</p>
|
screen session on and use the following procedure:</p>
|
||||||
|
|
||||||
<ol>
|
<ol>
|
||||||
|
|
|
@ -48,7 +48,7 @@
|
||||||
</div>
|
</div>
|
||||||
<br>
|
<br>
|
||||||
<div class="alert alert-info">
|
<div class="alert alert-info">
|
||||||
You must setup SMTP as described
|
You must set up SMTP as described
|
||||||
<a target="_blank" rel="noopener noreferrer" href="https://zulip.readthedocs.io/en/latest/subsystems/email.html#development-and-testing">
|
<a target="_blank" rel="noopener noreferrer" href="https://zulip.readthedocs.io/en/latest/subsystems/email.html#development-and-testing">
|
||||||
here</a> first before enabling this.
|
here</a> first before enabling this.
|
||||||
</div>
|
</div>
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
Run your favorite chatbot in Zulip!
|
Run your favorite chatbot in Zulip!
|
||||||
|
|
||||||
0. [Install errbot](https://errbot.readthedocs.io/en/latest/user_guide/setup.html)
|
0. [Install errbot](https://errbot.readthedocs.io/en/latest/user_guide/setup.html)
|
||||||
and follow to instructions to setup a `config.py`.
|
and follow to instructions to set up a `config.py`.
|
||||||
|
|
||||||
0. Check our our [Errbot integration package for Zulip](https://github.com/zulip/errbot-backend-zulip)
|
0. Check our our [Errbot integration package for Zulip](https://github.com/zulip/errbot-backend-zulip)
|
||||||
Clone this repository somewhere convenient.
|
Clone this repository somewhere convenient.
|
||||||
|
|
|
@ -41,7 +41,7 @@ CONTINUOUS_INTEGRATION = 'GITHUB_ACTIONS' in os.environ or 'CIRCLECI' in os.envi
|
||||||
|
|
||||||
if not os.path.exists(os.path.join(ZULIP_PATH, ".git")):
|
if not os.path.exists(os.path.join(ZULIP_PATH, ".git")):
|
||||||
print(FAIL + "Error: No Zulip git repository present!" + ENDC)
|
print(FAIL + "Error: No Zulip git repository present!" + ENDC)
|
||||||
print("To setup the Zulip development environment, you should clone the code")
|
print("To set up the Zulip development environment, you should clone the code")
|
||||||
print("from GitHub, rather than using a Zulip production release tarball.")
|
print("from GitHub, rather than using a Zulip production release tarball.")
|
||||||
sys.exit(1)
|
sys.exit(1)
|
||||||
|
|
||||||
|
|
|
@ -166,7 +166,7 @@ def generate_sprite_css_files(cache_path: str,
|
||||||
# Why is the test here has_img_google and not
|
# Why is the test here has_img_google and not
|
||||||
# emoji_is_universal? Because we briefly supported all
|
# emoji_is_universal? Because we briefly supported all
|
||||||
# Google emoji (not just the universal ones), we need to
|
# Google emoji (not just the universal ones), we need to
|
||||||
# ensure the spritesheet is setup to correctly display
|
# ensure the spritesheet is set up to correctly display
|
||||||
# those google emoji (in case anyone used them).
|
# those google emoji (in case anyone used them).
|
||||||
|
|
||||||
"""
|
"""
|
||||||
|
@ -276,11 +276,11 @@ def setup_emoji_farms(cache_path: str, emoji_data: List[Dict[str, Any]]) -> None
|
||||||
|
|
||||||
generate_sprite_css_files(cache_path, emoji_data, emojiset, alt_name)
|
generate_sprite_css_files(cache_path, emoji_data, emojiset, alt_name)
|
||||||
|
|
||||||
# Setup standard emojisets.
|
# Set up standard emojisets.
|
||||||
for emojiset in ['google', 'twitter']:
|
for emojiset in ['google', 'twitter']:
|
||||||
setup_emoji_farm(emojiset, emoji_data)
|
setup_emoji_farm(emojiset, emoji_data)
|
||||||
|
|
||||||
# Setup old google "blobs" emojiset.
|
# Set up old google "blobs" emojiset.
|
||||||
GOOGLE_BLOB_EMOJI_DATA_PATH = os.path.join(NODE_MODULES_PATH,
|
GOOGLE_BLOB_EMOJI_DATA_PATH = os.path.join(NODE_MODULES_PATH,
|
||||||
'emoji-datasource-google-blob',
|
'emoji-datasource-google-blob',
|
||||||
'emoji.json')
|
'emoji.json')
|
||||||
|
@ -348,7 +348,7 @@ def dump_emojis(cache_path: str) -> None:
|
||||||
emoji_data = orjson.loads(emoji_data_file.read())
|
emoji_data = orjson.loads(emoji_data_file.read())
|
||||||
emoji_catalog = generate_emoji_catalog(emoji_data, EMOJI_NAME_MAPS)
|
emoji_catalog = generate_emoji_catalog(emoji_data, EMOJI_NAME_MAPS)
|
||||||
|
|
||||||
# Setup emoji farms.
|
# Set up emoji farms.
|
||||||
if os.path.exists(cache_path):
|
if os.path.exists(cache_path):
|
||||||
shutil.rmtree(cache_path)
|
shutil.rmtree(cache_path)
|
||||||
setup_emoji_farms(cache_path, emoji_data)
|
setup_emoji_farms(cache_path, emoji_data)
|
||||||
|
|
|
@ -795,7 +795,7 @@ def zulip_otp_required(
|
||||||
if not user.is_authenticated: # nocoverage
|
if not user.is_authenticated: # nocoverage
|
||||||
return True
|
return True
|
||||||
|
|
||||||
# If the user doesn't have 2FA setup, we can't enforce 2FA.
|
# If the user doesn't have 2FA set up, we can't enforce 2FA.
|
||||||
if not user_has_device(user):
|
if not user_has_device(user):
|
||||||
return True
|
return True
|
||||||
|
|
||||||
|
|
|
@ -181,7 +181,7 @@ NON_EXPORTED_TABLES = {
|
||||||
# expire after a few days.
|
# expire after a few days.
|
||||||
'zerver_missedmessageemailaddress',
|
'zerver_missedmessageemailaddress',
|
||||||
|
|
||||||
# When switching servers, clients will need to re-login and
|
# When switching servers, clients will need to re-log in and
|
||||||
# reregister for push notifications anyway.
|
# reregister for push notifications anyway.
|
||||||
'zerver_pushdevicetoken',
|
'zerver_pushdevicetoken',
|
||||||
|
|
||||||
|
|
|
@ -25,7 +25,7 @@ Contact {support_email} if you need help debugging!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
INVALID_JSON_MESSAGE = """
|
INVALID_JSON_MESSAGE = """
|
||||||
Hi there! It looks like you tried to setup the Zulip {webhook_name} integration,
|
Hi there! It looks like you tried to set up the Zulip {webhook_name} integration,
|
||||||
but didn't correctly configure the webhook to send data in the JSON format
|
but didn't correctly configure the webhook to send data in the JSON format
|
||||||
that this integration expects!
|
that this integration expects!
|
||||||
"""
|
"""
|
||||||
|
|
|
@ -818,7 +818,7 @@ class SocialAuthBase(DesktopFlowTestingLib, ZulipTestCase):
|
||||||
/register (True) or /login (False). This is important
|
/register (True) or /login (False). This is important
|
||||||
because we need to verify behavior like the
|
because we need to verify behavior like the
|
||||||
"Continue to registration" if you try to log in using an
|
"Continue to registration" if you try to log in using an
|
||||||
account that doesn't exist but is allowed to signup.
|
account that doesn't exist but is allowed to sign up.
|
||||||
* next: Parameter passed through in production authentication
|
* next: Parameter passed through in production authentication
|
||||||
to redirect the user to (e.g.) the specific page in the webapp
|
to redirect the user to (e.g.) the specific page in the webapp
|
||||||
that they clicked a link to before being presented with the login
|
that they clicked a link to before being presented with the login
|
||||||
|
@ -1282,12 +1282,12 @@ class SocialAuthBase(DesktopFlowTestingLib, ZulipTestCase):
|
||||||
multiuse_object_key = multiuse_confirmation.confirmation_key
|
multiuse_object_key = multiuse_confirmation.confirmation_key
|
||||||
account_data_dict = self.get_account_data_dict(email=email, name=name)
|
account_data_dict = self.get_account_data_dict(email=email, name=name)
|
||||||
|
|
||||||
# First, try to signup for closed realm without using an invitation
|
# First, try to sign up for closed realm without using an invitation
|
||||||
result = self.social_auth_test(account_data_dict,
|
result = self.social_auth_test(account_data_dict,
|
||||||
expect_choose_email_screen=True,
|
expect_choose_email_screen=True,
|
||||||
subdomain=subdomain, is_signup=True)
|
subdomain=subdomain, is_signup=True)
|
||||||
result = self.client_get(result.url)
|
result = self.client_get(result.url)
|
||||||
# Verify that we're unable to signup, since this is a closed realm
|
# Verify that we're unable to sign up, since this is a closed realm
|
||||||
self.assertEqual(result.status_code, 200)
|
self.assertEqual(result.status_code, 200)
|
||||||
self.assert_in_success_response(["Sign up"], result)
|
self.assert_in_success_response(["Sign up"], result)
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue