Skip to content

Commit a734d5a

Browse files
committed
Some final edits to the documentation
The first pass, where I just ran Vale on things to see where it got me, still had room for improvement. I even "fixed" an instance of passive voice by introducing an obvious (in retrospect) grammatical error. Neat.
1 parent 83bf2bf commit a734d5a

File tree

3 files changed

+8
-9
lines changed

3 files changed

+8
-9
lines changed

README.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ You'll need the [Go][go] toolchain installed to try the demo program.
2424
1. See what to do next: `./randomizer-demo help`
2525

2626
The demo saves groups in a [bbolt][bbolt] database in the current directory,
27-
and outputs responses using [Slack's message formatting][format]. This gives a
27+
and outputs responses using [Slack's "mrkdwn" format][format]. This gives a
2828
taste of how the command works, and helps with testing.
2929

3030
[go]: https://golang.org/
@@ -38,9 +38,8 @@ Slack:
3838

3939
- `SERVERLESS.md` is a detailed walkthrough for deployment on [AWS
4040
Lambda][lambda], Amazon's managed function as a service platform.
41-
- `SERVERMORE.md` is a high-level guide for setting up the `randomizer-server`
42-
HTTP server, that assumes more background knowledge and/or willingness to
43-
dive into details of both standard server management and the randomizer
44-
implementation.
41+
- `SERVERMORE.md` is a high-level guide for configuring the `randomizer-server`
42+
HTTP server. It assumes more background knowledge and/or willingness to dive
43+
into the details of server management and the randomizer implementation.
4544

4645
[lambda]: https://aws.amazon.com/lambda/

SERVERLESS.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ Run `./hfc help` to learn more about additional commands that might be useful.
130130
transformation to simplify the setup of the Lambda function.
131131
- The template provisions the DynamoDB table in On-Demand capacity mode, which
132132
isn't eligible for the AWS Free Tier. See the [Read/Write Capacity
133-
Mode][capacity mode] documentation for more details.
133+
Mode][capacity mode] documentation for details.
134134
- The default configuration enables [AWS X-Ray][x-ray] tracing for the function
135135
and its requests to DynamoDB. X-Ray is free for up to 100,000 traces per month
136136
for every AWS account, and it's useful to see where each request is spending

SERVERMORE.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ This guide **doesn't** cover:
1414
you wish to use a cloud provider for group storage or secrets.
1515

1616
If you're uncomfortable with these topics or the rest of this guide, and you
17-
aren't interested in learning them, the AWS Lambda setup might be preferable
18-
(see `SERVERLESS.md`).
17+
aren't interested in learning them, you might prefer the AWS Lambda setup in
18+
`SERVERLESS.md`.
1919

2020
In addition to the environment variables below, see `randomizer-server -help`
2121
for CLI flags that you may wish to set, like the bind address for the server
@@ -73,7 +73,7 @@ operational ease comparable to the AWS Lambda solution (though the randomizer
7373
doesn't include infrastructure-as-code for it out of the box).
7474

7575
The Firestore backend requires a pre-existing database in a Google Cloud
76-
project (only Native mode been tested, but Datastore mode may work too).
76+
project (only Native mode has been tested, but Datastore mode may work too).
7777
Note that the randomizer expects to use the full database, and that only the
7878
"(default)" database in each Google Cloud project is eligible for the Firestore
7979
free tier.

0 commit comments

Comments
 (0)