From 752302c318b29a71bc5c75287e15a3e75d3aa0fa Mon Sep 17 00:00:00 2001 From: Samuel Wright Date: Tue, 11 Jun 2019 17:28:43 +0200 Subject: [PATCH] Bunch of typos and misformatting --- README.md | 3 ++- docs/CONTRIBUTING.md | 4 ++-- docs/GETTING_STARTED.md | 5 ++--- docs/docker.md | 2 +- docs/provisioners.md | 4 ++-- docs/questions.md | 2 +- 6 files changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 6b9faafe..22e49ef8 100644 --- a/README.md +++ b/README.md @@ -330,9 +330,10 @@ you are interested in. Ex: `step help ca provisioners list`. 3. On the web at https://smallstep.com/docs/certificates. -4. On your browser by running `step ca help --http :8080` from the command line +4. On your browser by running `step help --http=:8080 ca` from the command line and visiting http://localhost:8080. + ## The Future We plan to build more tools that facilitate the use and management of zero trust diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 3b70d082..f7ef7896 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -16,7 +16,7 @@ to manage issues, etc. ## Asking Support Questions Users and developers can ask questions over email (info@smallstep.com) or -[twitter](https://twitter.com/smallsteplabs). Please don't use the GitHub +[twitter](https://twitter.com/smallsteplabs). Please don't use the GitHub issue tracker to ask questions. ## Reporting Issues @@ -29,7 +29,7 @@ certificates` in use (`step-ca version`) and your operating system. ## Code Contribution -'step certificates` aims to become a fully featured online Certificate +`step certificates` aims to become a fully featured online Certificate Authority. We encourage all contributions that meet the following criteria: * fit naturally into a Certificate Authority. diff --git a/docs/GETTING_STARTED.md b/docs/GETTING_STARTED.md index c7cedb61..219c564e 100644 --- a/docs/GETTING_STARTED.md +++ b/docs/GETTING_STARTED.md @@ -1,6 +1,6 @@ # Getting Started -Demonstrates setting up your own PKI and certificate authority using `step ca` +Demonstrates setting up your own public key infrastructure (PKI) and certificate authority (CA) using `step ca` and getting certificates using the `step` command line tool and SDK. Check out [Getting started with docker](docker.md) to run [step certificates](https://github.com/smallstep/certificates) @@ -364,7 +364,7 @@ $ bin/step ca provisioner list ``` Now let's `reload` the CA. You will need to re-enter your intermediate -password unless it's in your `ca.json` or your are using `--password-file`. +password unless it's in your `ca.json` or you are using `--password-file`. ``` $ ps aux | grep step-ca # to get the PID @@ -609,4 +609,3 @@ are features that we plan to implement, but are not yet available. In the mean time short lived certificates are a decent alternative. * Keep your hosts secure by enforcing AuthN and AuthZ for every connection. SSH access is a big one. - diff --git a/docs/docker.md b/docs/docker.md index 439a3807..9202e300 100644 --- a/docs/docker.md +++ b/docs/docker.md @@ -61,7 +61,7 @@ cli](https://github.com/smallstep/cli#installation-guide). 5. Place the PKI root password in a known location. Our image is expecting the password to be placed in `/home/step/secrets/password` - you can simple go in to the terminal again and write that file: + you can simply go in to the terminal again and write that file: ```sh $ docker run -it -v step:/home/step smallstep/step-ca sh diff --git a/docs/provisioners.md b/docs/provisioners.md index 0038659a..2b2f8c5e 100644 --- a/docs/provisioners.md +++ b/docs/provisioners.md @@ -6,7 +6,7 @@ can be used to authenticate with the CA and get a certificate. ## JWK -JWK is the default provisioner type. It uses public-key cryptography sign and +JWK is the default provisioner type. It uses public-key cryptography to sign and validate a JSON Web Token (JWT). The [step](https://github.com/smallstep/cli) CLI tool will create a JWK @@ -55,7 +55,7 @@ In the ca.json configuration file, a complete JWK provisioner example looks like We can use [step](https://github.com/smallstep/cli) to see the private key encrypted with the password `asdf`: - + ```sh $ echo ey...lw | step crypto jwe decrypt | jq Please enter the password to decrypt the content encryption key: diff --git a/docs/questions.md b/docs/questions.md index 723d232d..f930933c 100644 --- a/docs/questions.md +++ b/docs/questions.md @@ -108,7 +108,7 @@ automated method as your system grows. Absolutely. [Details here]. -## Furher Reading +## Further Reading * [Use TLS Everywhere](https://smallstep.com/blog/use-tls.html) * [Everything you should know about certificates and PKI but are too afraid to ask](https://smallstep.com/blog/everything-pki.html)