docs: fix markdown style issues
@@ -37,6 +37,7 @@ our ability to support them effectively.
This project is very early and in active development. It isn't yet ready for testing, which is why we're not producing builds or documentation yet. If you're interested in following along with the project, drop into our community Slack channel #influxdb_iox. You can find [links to join here](https://community.influxdata.com/).
We're also hosting monthly tech talks and community office hours on the project on the 2nd Wednesday of the month at 8:30 AM Pacific Time.
+
* [Signup for upcoming IOx tech talks](https://www.influxdata.com/community-showcase/influxdb-tech-talks)
* [Watch past IOx tech talks](https://www.youtube.com/playlist?list=PLYt2jfZorkDp-PKBS05kf2Yx2NrRyPAAz)
@@ -108,7 +109,13 @@ failed to invoke protoc (hint: https://docs.rs/prost-build/#sourcing-protoc): Ba
```
Prost bundles a `protoc` binary, which it uses if it cannot find a system alternative.
-The binary it chooses with the above error is an `x86` one, which won't work if you do not have Rosetta installed on your system.
+Prior to version 0.9, the binary it chooses with the above error is an `x86` one, which won't work if you do not have Rosetta installed on your system.
+
+You can install Rosetta by running:
+
+```shell
+softwareupdate --install-rosetta
+```
An alternative to installing Rosetta is to point Prost at an `arm` build of `protoc`.
First, install `protoc`, e.g., via Homebrew:
@@ -203,31 +210,35 @@ To run all available tests in debug mode, you may want to set min stack size to
```shell
RUST_MIN_STACK=10485760 cargo test --all
```
+
### Build a Docker image (optional)
Building the Docker image requires:
-- Docker 18.09+
-- BuildKit
+* Docker 18.09+
+* BuildKit
To [enable BuildKit] by default, set `{ "features": { "buildkit": true } }` in the Docker engine configuration,
or run `docker build` with`DOCKER_BUILDKIT=1`
To build the Docker image:
-```
+```shell
DOCKER_BUILDKIT=1 docker build .
```
[Enable BuildKit]: https://docs.docker.com/develop/develop-images/build_enhancements/#to-enable-buildkit-builds
+
### Write and read data
Each IOx instance requires a writer ID.
This can be set one of 4 ways:
-- set an environment variable `INFLUXDB_IOX_ID=42`
-- set a flag `--writer-id 42`
-- use the API (not convered here)
-- use the CLI
+
+* set an environment variable `INFLUXDB_IOX_ID=42`
+* set a flag `--writer-id 42`
+* use the API (not convered here)
+* use the CLI
+
```shell
influxdb_iox writer set 42
```
