docs: translate single-quotes into backticks

This commit is contained in:
Jose Diaz-Gonzalez
2021-09-12 07:01:57 -04:00
parent e4035a1faa
commit 73fb35f3a8
2 changed files with 25 additions and 15 deletions

View File

@@ -181,7 +181,7 @@ flags:
- `-a|--alias "BLUE_DATABASE"`: an alternative alias to use for linking to an app via environment variable - `-a|--alias "BLUE_DATABASE"`: an alternative alias to use for linking to an app via environment variable
- `-q|--querystring "pool=5"`: ampersand delimited querystring arguments to append to the service link - `-q|--querystring "pool=5"`: ampersand delimited querystring arguments to append to the service link
A mysql service can be linked to a container. This will use native docker links via the docker-options plugin. Here we link it to our 'playground' app. A mysql service can be linked to a container. This will use native docker links via the docker-options plugin. Here we link it to our `playground` app.
> NOTE: this will restart your app > NOTE: this will restart your app
@@ -206,7 +206,7 @@ The following will be set on the linked application by default:
DATABASE_URL=mysql://lolipop:SOME_PASSWORD@dokku-mysql-lolipop:3306/lolipop DATABASE_URL=mysql://lolipop:SOME_PASSWORD@dokku-mysql-lolipop:3306/lolipop
``` ```
The host exposed here only works internally in docker containers. If you want your container to be reachable from outside, you should use the 'expose' subcommand. Another service can be linked to your app: The host exposed here only works internally in docker containers. If you want your container to be reachable from outside, you should use the `expose` subcommand. Another service can be linked to your app:
```shell ```shell
dokku mysql:link other_service playground dokku mysql:link other_service playground
@@ -401,7 +401,7 @@ Service scripting can be executed using the following commands:
dokku mysql:app-links <app> dokku mysql:app-links <app>
``` ```
List all mysql services that are linked to the 'playground' app. List all mysql services that are linked to the `playground` app.
```shell ```shell
dokku mysql:app-links playground dokku mysql:app-links playground
@@ -448,7 +448,7 @@ dokku mysql:exists lolipop
dokku mysql:linked <service> <app> dokku mysql:linked <service> <app>
``` ```
Here we check if the lolipop mysql service is linked to the 'playground' app. Here we check if the lolipop mysql service is linked to the `playground` app.
```shell ```shell
dokku mysql:linked lolipop playground dokku mysql:linked lolipop playground
@@ -461,7 +461,7 @@ dokku mysql:linked lolipop playground
dokku mysql:links <service> dokku mysql:links <service>
``` ```
List all apps linked to the 'lolipop' mysql service. List all apps linked to the `lolipop` mysql service.
```shell ```shell
dokku mysql:links lolipop dokku mysql:links lolipop
@@ -566,12 +566,18 @@ flags:
- `-u|--use-iam`: use the IAM profile associated with the current server - `-u|--use-iam`: use the IAM profile associated with the current server
Backup the 'lolipop' service to the 'my-s3-bucket' bucket on ``AWS`:` Backup the `lolipop` service to the `my-s3-bucket` bucket on `AWS`:`
```shell ```shell
dokku mysql:backup lolipop my-s3-bucket --use-iam dokku mysql:backup lolipop my-s3-bucket --use-iam
``` ```
Restore a backup file (assuming it was extracted via `tar -xf backup.tgz`):
```shell
dokku mysql:import lolipop < backup-folder/export
```
### sets encryption for all future backups of mysql service ### sets encryption for all future backups of mysql service
```shell ```shell

View File

@@ -423,13 +423,13 @@ def command_data(command, service, variable, alias, image, scheme, ports):
def process_sentence(sentence_lines): def process_sentence(sentence_lines):
sentence_lines = " ".join(sentence_lines) sentence_lines = " ".join(sentence_lines)
sentences = ". ".join( sentences = ". ".join(
upperfirst(i.strip()) for i in sentence_lines.split(".") upperfirst(i.strip()) for i in sentence_lines.split(". ")
).strip() ).strip()
if not sentences.endswith(".") and not sentences.endswith(":"): if not sentences.endswith(".") and not sentences.endswith(":"):
sentences += ":" sentences += ":"
text = [] text = []
for sentence in sentences.split("."): for sentence in sentences.split(". "):
parts = [] parts = []
for word in sentence.strip().split(" "): for word in sentence.strip().split(" "):
if word.isupper() and len(word) > 1: if word.isupper() and len(word) > 1:
@@ -444,7 +444,11 @@ def process_sentence(sentence_lines):
text = ". ".join(text) text = ". ".join(text)
# some cleanup # some cleanup
text = text.replace("(0. 0. 0. 0)", "(`0.0.0.0`)") text = text.replace("(0.0.0.0)", "(`0.0.0.0`)")
text = text.replace("'", "`")
text = text.replace("`s", "'s")
text = text.replace("``", "`")
text = text.strip(" ")
return text return text