e2e-tests: Fix the documentation Table of Contents

Fix section headers indentation so they properly show in the page ToC.

Rename sections while removing thus merging some; improve ToC usability.

Change-Id: I83d6b6dfbb83e67105bbdb29196be060c9b518f3
This commit is contained in:
Marco Miller
2020-01-30 15:45:02 -05:00
parent 75a604684a
commit 62c30e5323

View File

@@ -21,9 +21,7 @@ implementation easy even without any Scala knowledge.
Examples of scenarios can be found in the `e2e-tests` directory. Examples of scenarios can be found in the `e2e-tests` directory.
=== How to run the load tests == How to build the tests
==== How to build
An link:https://www.scala-sbt.org/download.html[sbt-based installation] of An link:https://www.scala-sbt.org/download.html[sbt-based installation] of
link:https://www.scala-lang.org/download/[Scala] is required. link:https://www.scala-lang.org/download/[Scala] is required.
@@ -45,13 +43,15 @@ example which is singular.
[warn] Credentials file ~/.sbt/sonatype_credentials does not exist [warn] Credentials file ~/.sbt/sonatype_credentials does not exist
---- ----
==== How to build using Docker === How to build using Docker
---- ----
docker build . -t e2e-tests docker build . -t e2e-tests
---- ----
==== Setup == How to set-up
=== SSH keys
If you are running SSH commands, the private keys of the users used for testing need to go in If you are running SSH commands, the private keys of the users used for testing need to go in
`/tmp/ssh-keys`. The keys need to be generated this way (JSch won't validate them `/tmp/ssh-keys`. The keys need to be generated this way (JSch won't validate them
@@ -63,7 +63,7 @@ ssh-keygen -m PEM -t rsa -C "test@mail.com" -f /tmp/ssh-keys/id_rsa
*NOTE*: Don't forget to add the public keys for the testing user(s) to your git server. *NOTE*: Don't forget to add the public keys for the testing user(s) to your git server.
==== Input file === Input file
The `ReplayRecordsFromFeederScenario` is fed with the data coming from the The `ReplayRecordsFromFeederScenario` is fed with the data coming from the
`src/test/resources/data/requests.json` file. Such a file contains the commands and repo used `src/test/resources/data/requests.json` file. Such a file contains the commands and repo used
@@ -89,7 +89,7 @@ Valid commands are:
* `push` * `push`
* `clone` * `clone`
==== How to use the framework == How to run tests
Run all tests: Run all tests:
---- ----
@@ -106,7 +106,7 @@ Generate the last report:
sbt "gatling:lastReport" sbt "gatling:lastReport"
---- ----
==== How to run using Docker === How to run using Docker
---- ----
docker run -it e2e-tests -s com.google.gerrit.scenarios.ReplayRecordsFromFeederScenario docker run -it e2e-tests -s com.google.gerrit.scenarios.ReplayRecordsFromFeederScenario