docs: move make build instruction from paragraph into list#3193
docs: move make build instruction from paragraph into list#3193polarathene merged 3 commits intodocker-mailserver:masterfrom jrpear:clarify-testing-doc
make build instruction from paragraph into list#3193Conversation
|
The diff for this change is a bit ugly because I had to renumber the items in the list. Markdown doesn't actually care what the number before the period is. These two lists render the same: and The latter makes for nicer diffs and editing. What do you think of changing every list in the docs to use the latter sort of list? I suppose the downside is that the raw markdown is marginally less nice. |
| 2. Run a single test: `make clean generate-accounts test/<TEST NAME WITHOUT .bats SUFFIX>` | ||
| 3. Run multiple unrelated tests: `make clean generate-accounts test/<TEST NAME WITHOUT .bats SUFFIX>,<TEST NAME WITHOUT .bats SUFFIX>` (just add a `,` and then immediately write the new test name) | ||
| 4. Run a whole set or all serial tests: `make clean generate-accounts tests/parallel/setX` where `X` is the number of the set or `make clean generate-accounts tests/serial` | ||
| 1. First, build the container image: `make build`. You can then: |
There was a problem hiding this comment.
| 1. First, build the container image: `make build`. You can then: | |
| 1. Run `make build` to create or update the local `mailserver-testing:ci` Docker image (_using the projects `Dockerfile`_) |
There was a problem hiding this comment.
Run `make build` to create or update the local `mailserver-testing:ci` Docker image (_using the projects `Dockerfile`_)
doesn't say that the following commands depend on the first one. I think this might be better:
First, run `make build` to create or update the local `mailserver-testing:ci` Docker image (_using the projects `Dockerfile`_)
|
Documentation preview for this PR is ready! 🎉 Built with commit: 7417025 |
My preference is to keep the order explicit, we rarely need to make such changes. Diff quality in Github web UI isn't great but I think some other tools do a better job (eg: Meld) usually at rendering the relevant changes. I also know that our docs generator IIRC, one of those is that indented/nested lists need to be 4 spaces wide, anything less and it's treated at the same level, and increments the items with the same logic that you bring up. |
Ah makes sense. 👍 |
Description
Move
make buildinstruction from paragraph into listClarifies confusion in #3191
Type of change