[docs] Overhaul the documentation #136
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There were multiple mentions of how to run a server, all of them slightly different. This reorganizes the documentation to have a single place explaining how to run a server, either locally or in production via Docker. This also moves the documentation of the deprecated `nts` test suite to a less prominent location -- we should actually see if that can be removed entirely. Finally, it updates the Quickstart section of "Running tests" to ensure that the commands actually run on anyone's machine. A quickstart should not require custom setup.
| Sometimes machine can literally be a machine, but more abstractly, it can be any | ||
| configuration you are interested in tracking. For example, to store results | ||
| from an Arm test machine, you could have a machine call "ArmMachine"; but, you | ||
| from an Arm test machine, you could have a machine call "ArmMachine"; but, you |
| "ArmMachine-Debug", when you compile the thing you want to test in two modes. | ||
| When doing testing of LLVM, we often string all the useful parameters of the | ||
| configuration into one machines name:: | ||
| configuration into one machines name:: |
Contributor
There was a problem hiding this comment.
machine -> machine's
Or it could be "one machine name" to speak generically about a name to be applied to any machine.
| ---------------------- | ||
|
|
||
| The lnt importreport tool is an easy way to import data into LNTs test format. | ||
| The ``lnt importreport`` tool is an easy way to import data into LNTs test format. |
|
|
||
| CREATE DATABASE "lnt.db" | ||
| This will install the client-side tools. If you also want to run a production | ||
| server, you should instead include the server-side optional requirements:: |
Contributor
There was a problem hiding this comment.
You say "also want" but then "instead", one means both the other means pick only one.
If you drop the also and make it an either choice it would make more sense:
"
If you want to run a production server, you should instead install the server-side requirements::"
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There were multiple mentions of how to run a server, all of them slightly different. This reorganizes the documentation to have a single place explaining how to run a server, either locally or in production via Docker.
This also moves the documentation of the deprecated
ntstest suite to a less prominent location -- we should actually see if that can be removed entirely.Finally, it updates the Quickstart section of "Running tests" to ensure that the commands actually run on anyone's machine. A quickstart should not require custom setup.