From 73fb35f3a8f3936ddb2e343fd8ad1ceea0136d15 Mon Sep 17 00:00:00 2001 From: Jose Diaz-Gonzalez Date: Sun, 12 Sep 2021 07:01:57 -0400 Subject: [PATCH] docs: translate single-quotes into backticks --- README.md | 30 ++++++++++++++++++------------ bin/generate | 10 +++++++--- 2 files changed, 25 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index f8c7d36..25dda4a 100644 --- a/README.md +++ b/README.md @@ -77,7 +77,7 @@ Create a mysql service named lolipop: dokku mysql:create lolipop ``` -You can also specify the image and image version to use for the service. It *must* be compatible with the mysql image. +You can also specify the image and image version to use for the service. It *must* be compatible with the mysql image. ```shell export DATABASE_IMAGE="mysql" @@ -85,7 +85,7 @@ export DATABASE_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}" dokku mysql:create lolipop ``` -You can also specify custom environment variables to start the mysql service in semi-colon separated form. +You can also specify custom environment variables to start the mysql service in semi-colon separated form. ```shell export DATABASE_CUSTOM_ENV="USER=alpha;HOST=beta" @@ -181,7 +181,7 @@ flags: - `-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 -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 @@ -206,13 +206,13 @@ The following will be set on the linked application by default: 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 dokku mysql:link other_service playground ``` -It is possible to change the protocol for `DATABASE_URL` by setting the environment variable `MYSQL_DATABASE_SCHEME` on the app. Doing so will after linking will cause the plugin to think the service is not linked, and we advise you to unlink before proceeding. +It is possible to change the protocol for `DATABASE_URL` by setting the environment variable `MYSQL_DATABASE_SCHEME` on the app. Doing so will after linking will cause the plugin to think the service is not linked, and we advise you to unlink before proceeding. ```shell dokku config:set playground MYSQL_DATABASE_SCHEME=mysql2 @@ -264,13 +264,13 @@ dokku mysql:connect lolipop dokku mysql:enter ``` -A bash prompt can be opened against a running service. Filesystem changes will not be saved to disk. +A bash prompt can be opened against a running service. Filesystem changes will not be saved to disk. ```shell dokku mysql:enter lolipop ``` -You may also run a command directly against the service. Filesystem changes will not be saved to disk. +You may also run a command directly against the service. Filesystem changes will not be saved to disk. ```shell dokku mysql:enter lolipop touch /tmp/test @@ -401,7 +401,7 @@ Service scripting can be executed using the following commands: dokku mysql:app-links ``` -List all mysql services that are linked to the 'playground' app. +List all mysql services that are linked to the `playground` app. ```shell dokku mysql:app-links playground @@ -435,7 +435,7 @@ dokku mysql:clone lolipop lolipop-2 dokku mysql:exists ``` -Here we check if the lolipop mysql service exists. +Here we check if the lolipop mysql service exists. ```shell dokku mysql:exists lolipop @@ -448,7 +448,7 @@ dokku mysql:exists lolipop dokku mysql:linked ``` -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 dokku mysql:linked lolipop playground @@ -461,7 +461,7 @@ dokku mysql:linked lolipop playground dokku mysql:links ``` -List all apps linked to the 'lolipop' mysql service. +List all apps linked to the `lolipop` mysql service. ```shell dokku mysql:links lolipop @@ -566,12 +566,18 @@ flags: - `-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 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 ```shell diff --git a/bin/generate b/bin/generate index 2a04b0a..e38a931 100755 --- a/bin/generate +++ b/bin/generate @@ -423,13 +423,13 @@ def command_data(command, service, variable, alias, image, scheme, ports): def process_sentence(sentence_lines): sentence_lines = " ".join(sentence_lines) sentences = ". ".join( - upperfirst(i.strip()) for i in sentence_lines.split(".") + upperfirst(i.strip()) for i in sentence_lines.split(". ") ).strip() if not sentences.endswith(".") and not sentences.endswith(":"): sentences += ":" text = [] - for sentence in sentences.split("."): + for sentence in sentences.split(". "): parts = [] for word in sentence.strip().split(" "): if word.isupper() and len(word) > 1: @@ -444,7 +444,11 @@ def process_sentence(sentence_lines): text = ". ".join(text) # 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