paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-10-23 04:52:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Apply bullet style changes from Prettier.

Browse Source 
Signed-off-by: Anders Kaseorg <anders@zulip.com>
(cherry picked from commit 915884bff7)
This commit is contained in:
Anders Kaseorg
2021-08-20 12:45:39 -07:00
committed by Tim Abbott
parent 5ae8fe292d
commit 0147c6adce
94 changed files with 1674 additions and 1674 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
tools/droplets/README.md
View File

@@ -52,8 +52,8 @@ Now you're ready to use the script.
`create.py` takes two arguments
* GitHub username
* Tags (Optional argument)
- GitHub username
- Tags (Optional argument)
```
$ python3 create.py <username>

2
tools/linter_lib/custom_check.py
View File

@@ -521,7 +521,7 @@ prose_style_rules: List["Rule"] = [
{
"pattern": "[oO]rganisation", # exclude usage in hrefs/divs
"description": "Organization is spelled with a z",
"exclude_line": {("docs/translating/french.md", "* organization - **organisation**")},
"exclude_line": {("docs/translating/french.md", "- organization - **organisation**")},
},
{"pattern": "!!! warning", "description": "!!! warning is invalid; it's spelled '!!! warn'"},
{"pattern": "Terms of service", "description": "The S in Terms of Service is capitalized"},

32
tools/oneclickapps/README.md
View File

@@ -18,42 +18,42 @@ server release.
You also need to set the following secrets in your GitHub repository to make the action
work correctly. These secrets are passed as environment variables to the GitHub action.
* `ONE_CLICK_ACTION_DIGITALOCEAN_API_KEY` - DigitalOcean API key used for creating droplets, snapshots etc.
* `ONE_CLICK_ACTION_ZULIP_BOT_API_KEY` - The API key of the Zulip bot used for sending messages.
* `ONE_CLICK_ACTION_ZULIP_BOT_EMAIL` - The email of the Zulip bot.
- `ONE_CLICK_ACTION_DIGITALOCEAN_API_KEY` - DigitalOcean API key used for creating droplets, snapshots etc.
- `ONE_CLICK_ACTION_ZULIP_BOT_API_KEY` - The API key of the Zulip bot used for sending messages.
- `ONE_CLICK_ACTION_ZULIP_BOT_EMAIL` - The email of the Zulip bot.
Also pass the following as environment variables in `.github/workflows/update-oneclick-apps.yml`.
* `PYTHON_DIGITALOCEAN_REQUEST_TIMEOUT_SEC` - This configures the maximum number of seconds
- `PYTHON_DIGITALOCEAN_REQUEST_TIMEOUT_SEC` - This configures the maximum number of seconds
to wait before the requests made by `python-digitalocean` time out. If not configured, it's
common for the requests to take 20+ minutes before getting timed out.
### Verifying the one click app image
* The action will send the image name and test droplet details to the stream configured in the
- The action will send the image name and test droplet details to the stream configured in the
above steps.
* SSH into the test droplet by following the instructions in the message.
* After logging into the test droplet, exit the installer and run the following script.
- SSH into the test droplet by following the instructions in the message.
- After logging into the test droplet, exit the installer and run the following script.
https://raw.githubusercontent.com/digitalocean/marketplace-partners/master/scripts/img_check.sh
This script checks whether the image created is valid. It is also run by the DigitalOcean team
before they approve the image submission in the one click app marketplace.
* If there are no errors (you can ignore most of the warnings), exit the SSH connection and
- If there are no errors (you can ignore most of the warnings), exit the SSH connection and
reconnect.
* Populate the details asked by the installer and verify that the installer completes successfully.
- Populate the details asked by the installer and verify that the installer completes successfully.
If there are errors see the section below.
* Use the link generated by the installer to create a new Zulip organization. Do some basic
- Use the link generated by the installer to create a new Zulip organization. Do some basic
testing like sending a bunch of messages and reloading the webpage.
* If there are no issues, submit the image in the
- If there are no issues, submit the image in the
[DigitalOcean vendor portal](https://marketplace.digitalocean.com/vendorportal). You need to be
added to the vendor portal team for doing this. Ask Tim to add you if required. During the submission,
make sure to update the blog post URL if it's a major release.
* Keep checking the vendor portal for change in status of the submission. DigitalOcean does nominally send
- Keep checking the vendor portal for change in status of the submission. DigitalOcean does nominally send
emails when there are updates on the submission, but we have found the emails to not always arrive.
* If there are any issues with submission, rebuild the image by manually invoking the script and
- If there are any issues with submission, rebuild the image by manually invoking the script and
resubmit. The issues we have seen mostly in the past are caused by the dependencies getting outdated
by the time the DigitalOcean team run the checks. In that case you have to just rebuild the image
by invoking the script.
* Delete the test droplet `oneclickapp-{release_version}-test` after you have completed testing
- Delete the test droplet `oneclickapp-{release_version}-test` after you have completed testing
by going to the [DigitalOcean Zulip team account](https://cloud.digitalocean.com/droplets?i=0242e0).
If there are other existing test droplets with the same name format but with with older release versions
feel free to delete them as well. These droplets are also tagged with `github-action` and`temporary`
@@ -62,9 +62,9 @@ Also pass the following as environment variables in `.github/workflows/update-on
**Errors**
If there are any errors while setting up the one click app installer, you have three options
* Include the fix in the Fabric script that setups the installer.
- Include the fix in the Fabric script that setups the installer.
[01-initial-setup](https://raw.githubusercontent.com/zulip/marketplace-partners/master/marketplace_docs/templates/Fabric/scripts/01-initial-setup)
file should be a good place to include the fix. See
[zulip/marketplace-partners#4](https://github.com/zulip/marketplace-partners/pull/4/files) for an
example fix.
* Wait for the next release to fix the error.
- Wait for the next release to fix the error.