diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 704efdf19..a2799d88f 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -31,7 +31,7 @@ > For problems affecting all applications, the report output for a broken application is useful for our debugging. > In these cases, you may run `dokku report` without any arguments to display the top-level reporting information. -### How (deb/make/rpm) and where (AWS, VirtualBox, physical, etc.) was Dokku installed?: +### How (deb/make/rpm) and where (AWS, VirtualBox, physical, etc.) was Dokku installed? ### Additional information diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index bcd025c41..15a72b1d2 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -1 +1 @@ -**Note:** If this PR is just doc changes, please put [ci skip] in the body that way tests do not run. +**Note:** If this PR is just doc changes, please put `[ci skip]` in the body that way tests do not run. diff --git a/docs/appendices/0.6.0-migration-guide.md b/docs/appendices/0.6.0-migration-guide.md index 96ce45136..23fd4e767 100644 --- a/docs/appendices/0.6.0-migration-guide.md +++ b/docs/appendices/0.6.0-migration-guide.md @@ -23,10 +23,10 @@ ## Calling the `dokku` binary - Plugins should *not* call the `dokku` binary directly. Clients using the `--app` argument are potentially broken, amongst others, when doing so. Instead, please source the `functions` file for a given plugin when attempting to call Dokku internal functions. As a result, the following Dokku commands are no longer publicly exposed: - - `dokku build` - - `dokku receive` - - `dokku release` - - `dokku tar:build` - - `dokku tar:build-locked` - - `dokku git:build` - - `dokku git:build-locked` + - `dokku build` + - `dokku receive` + - `dokku release` + - `dokku tar:build` + - `dokku tar:build-locked` + - `dokku git:build` + - `dokku git:build-locked` diff --git a/docs/getting-started/install/digitalocean.md b/docs/getting-started/install/digitalocean.md index f55f22cb6..e850c4b63 100644 --- a/docs/getting-started/install/digitalocean.md +++ b/docs/getting-started/install/digitalocean.md @@ -10,11 +10,11 @@ 4. Under **Choose a size**, select your machine spec. 5. Under **Choose a datacenter region**, select your region. 6. Add an SSH Key. - * New Keys + - New Keys 1. Under **Add your SSH keys** click **New SSH Key** _(this opens a dialog)_. 2. From your terminal, execute `cat $HOME/.ssh/id_rsa.pub`. 3. Copy the output and paste it into the **New SSH Key** dialog, provide a name and click **Add SSH Key**. - * Existing Keys + - Existing Keys 1. Simply add a checkmark next to the existing keys you'd like to add. 7. Under **Finalize and create**, give your Droplet a hostname _(not required)_ and click **Create**. 8. Once created, copy the IP address to your clipboard. diff --git a/docs/networking/dns.md b/docs/networking/dns.md index 4f9ee666e..78e82ac3f 100644 --- a/docs/networking/dns.md +++ b/docs/networking/dns.md @@ -18,11 +18,7 @@ Because there are so many different DNS server packages out there as well as a t ## Caching -Please remember that DNS relies heavily on _caching_. Changes you make to DNS could take anywhere from a few seconds to a few *days* to propagate. If you tried surfing to example.tld, then changed the IP address in DNS, it could be a while before your computer picks up on the changes. - -## HELP! - -Don't be afraid to ask if you need help. Create a [new issue](https://github.com/dokku/dokku/issues) and someone will be glad to assist you. +Please remember that DNS relies heavily on _caching_. Changes you make to DNS could take anywhere from a few seconds to a few _days_ to propagate. If you tried surfing to example.tld, then changed the IP address in DNS, it could be a while before your computer picks up on the changes. ## Getting started @@ -36,7 +32,7 @@ Now you have to make a decision about your domain. Do you want everything and a In other words, do you want your applications on your Dokku server accessible via `node-js-app.example.tld` or via `node-js-app.myserver.example.tld`? -#### Using a sub-domain (node-js-app.myserver.example.tld) +### Using a sub-domain (node-js-app.myserver.example.tld) Using a sub-domain is easy. When you set up your server, you probably gave it a name like `myserver.example.tld`. @@ -71,7 +67,7 @@ If they all return your IP address, you have set DNS up properly for dokku. You Proceed with the setup instructions in the [installation documentation](/docs/getting-started/installation.md) -#### Using the root of your domain (node-js-app.example.tld) +### Using the root of your domain (node-js-app.example.tld) This section is a work in progress. It is incomplete.