docs: more cleanup

This commit is contained in:
Jose Diaz-Gonzalez committed 2021-07-09 22:22:51 -04:00
1 parent 1b216841a8
commit a108856a98
5 files changed
+14 -18

No files matched your search

+1 -1
View File
@@ -31,7 +31,7 @@
> For problems affecting all applications, the report output for a broken application is useful for our debugging. > 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. > 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 ### Additional information
+1 -1
View File
@@ -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.
+7 -7
View File
@@ -23,10 +23,10 @@
## Calling the `dokku` binary ## 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: - 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 build`
- `dokku receive` - `dokku receive`
- `dokku release` - `dokku release`
- `dokku tar:build` - `dokku tar:build`
- `dokku tar:build-locked` - `dokku tar:build-locked`
- `dokku git:build` - `dokku git:build`
- `dokku git:build-locked` - `dokku git:build-locked`
+2 -2
View File
@@ -10,11 +10,11 @@
4. Under **Choose a size**, select your machine spec. 4. Under **Choose a size**, select your machine spec.
5. Under **Choose a datacenter region**, select your region. 5. Under **Choose a datacenter region**, select your region.
6. Add an SSH Key. 6. Add an SSH Key.
* New Keys - New Keys
1. Under **Add your SSH keys** click **New SSH Key** _(this opens a dialog)_. 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`. 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**. 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. 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**. 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. 8. Once created, copy the IP address to your clipboard.
+3 -7
View File
@@ -18,11 +18,7 @@ Because there are so many different DNS server packages out there as well as a t
## Caching ## 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. 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.
## Getting started ## 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`? 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`. 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) 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. This section is a work in progress. It is incomplete.