Commit Graph

100 Commits

Author SHA1 Message Date
Lars Holmberg 7152dc4c41 Add example of a bottlenecked server and use that test to make a new graph for the docs. 2024-07-17 22:10:05 +02:00
Sam 8f04a6bcd1
Docs: Import wiki to docs (#2734)
* Straight pandoc migration, no edits

* Minimum edits for the docs to build

- added imports to TOC
- deleted Home.rst
- removed spurious html formatting `li`, `h4` etc
- fixed H1s

Still to do

- rename files
- actually look at content :-p

* Blog post links live in ther forum now

* Move imported files to lowercase, update wiki links to docs links

* Move troubleshooting into installation

* Break out increasing request rate

* Remove duped content

* Remove duped content

* Codespell fixes

* Misc review feedback and fixes

* Just nuke it

* Fix line breaks

* This aint the wiki youre looking for
2024-06-07 11:48:47 +02:00
Lars Holmberg 6d11925849 Various grammar fixes in documentation. Remove references to legacy ui in docs. 2024-04-27 09:07:50 +02:00
Lars Holmberg 1a94044651 Fix various documentation issues, mostly spelling 2024-04-21 23:49:31 +02:00
Lars Holmberg 16a16d16c0 Docs: make it more clear that requests wait for responses until moving to the next line of code. 2024-04-10 10:09:47 +02:00
Dorin 8249d06e03
Update quickstart.rst
Fixed typo
2024-02-07 09:34:52 +00:00
Andrew Baldwin 008b189809 Set modern-ui as default 2024-01-29 10:22:03 -05:00
Andrew Baldwin 4e26d7021c Update quickstart.rst 2023-10-07 00:29:03 +02:00
Lars Holmberg 5bc1901cca Documentation: Restructure quickstart. Make it more clear that there is no pre-provided web site that answers to /hello and /world. 2022-12-23 09:24:33 +01:00
Lars Holmberg bca78cd94a Various documentation updates, mainly moved "using multiple locustfiles at once" and "class picker" from Quickstart to Configuration. 2022-10-17 09:24:30 +02:00
Lars Holmberg 5da71bb359 Document how to use separate shape files + shorten tick user_classes documentation. 2022-09-18 15:40:18 +02:00
Michael Nester fe3ad97192 userclass-picker: Added --class-picker flag to allow users to select User classes and shape class from WebUi. -f accepts a directory and multiple comma-separated files. 2022-08-09 10:28:04 -04:00
Xavier Sosnovsky 8b26da2444 Minor edits to the documentation 2022-07-23 17:13:30 +02:00
Kian-Meng Ang 18965d758d Fix typos 2022-02-21 19:14:55 +08:00
Lars Holmberg 394f582c4b Add documentation for debugging/run_single_user. Rename some poorly named documentation pages. 2022-01-27 08:45:13 +01:00
Lars Holmberg 20f3d8b9e1 Documentation fixes 2021-08-08 22:27:21 +02:00
Lars Holmberg 340f0b19ae Use plain text instead of alt text (because alt text is apparently not considered worthy of including in search matches, and lots of people seem to be searching for "RPS") 2021-08-08 21:29:41 +02:00
Lars Holmberg 63e5db4769 add some alt texts in documentation (hopefully they will be searchable?) 2021-08-08 21:14:33 +02:00
Lars Holmberg 3623c38de1 Various minor documentation fixes. Pin readthedocs-sphinx-search version. 2021-08-08 14:37:28 +02:00
Lars Holmberg 0df0330ed6 Documentation updates: Move QuickstartUser to "writing a locustfile". Minor other moves. 2021-08-01 21:34:24 +02:00
Lars Holmberg b0415599d0 Tons of documentation updates. 2021-08-01 10:06:41 +02:00
Lars Holmberg 3e18e34492 Update documentation. Change wording (no need to repeat the word "spawned") 2021-08-01 00:44:58 +02:00
Lars Holmberg b17da040f3 Various documentation improvements, including a better "hello world" example to get people started. Added Sphinx Substitution Extension in order to be able to add dynamic stuff (version number) into the documentation. 2021-07-27 13:14:55 +02:00
Jonatan Heyman ad41dd4fac Improve Quickstart documentation 2020-11-24 21:14:21 +01:00
Jonatan Heyman 03b6df4fab Re-add info on wait_time to Quickstart documentation and examples 2020-11-18 14:20:49 +01:00
Lars Holmberg 1670b424ad
Merge pull request #1612 from DennisKrone/keyboard-input
Add key commands for increasing and stopping users
2020-11-13 14:41:04 +01:00
Lars Holmberg ff98817fef documentation: rename task named index_page in examples, because it doesnt actually load an index page any more... 2020-11-12 20:06:27 +01:00
Dennis Kroné 77f64a8310 Update documentation regarding keyboard input 2020-11-12 13:37:31 +01:00
Lars Holmberg 7676b5389c Make wait_time = constant(0) the default instead of forcing our users to specify it. Makes a big difference in readability of small User classes and reduces the cognitive overhead for locust beginners. Fixes #1308 2020-11-11 22:14:20 +01:00
Dennis Kroné 137b7d9556 Update documentation with info about keyboard input. 2020-11-06 10:08:18 +01:00
Lars Holmberg df498981e6 tiny doc fixes 2020-10-12 08:59:51 +02:00
Lars Holmberg 9d8307145d Doc update. Make this heading a paragraph instead, so that it doesnt get added to any indexes. 2020-08-19 13:27:22 +02:00
Lars Holmberg ee7c41e149 tiny doc update 2020-08-18 19:20:29 +02:00
Lars Holmberg 62fa37bb7e Lots of updates/tweaks to quickstart and writing-a-locustfile documentation. 2020-08-18 00:05:35 +02:00
Lars Holmberg 7a4b7115d6 tiny doc fix 2020-08-16 21:25:05 +02:00
Lars Holmberg 729c370e71 Fix the link from installation to quickstart 2020-08-15 20:29:52 +02:00
Howard Osborne 08c51faa34 minor typos in docs 2020-06-25 12:08:06 +01:00
James Baker 13a01a7365 Quickstart documentation clarification. 2020-06-16 20:33:55 -04:00
Jonatan Heyman 7cd00ea948 Some minor changes to Quickstart docs 2020-05-22 11:52:36 +02:00
Lars Holmberg d04369246a quickstart: move wait_time back to the top 2020-05-19 14:54:21 +02:00
Lars Holmberg 4f7c302289 quickstart: inline locustfile.py again. Rename WebsiteUser to QuickstartUser instead of MyUser. some minor fixes/clarifications. 2020-05-19 14:24:01 +02:00
Lars Holmberg d6a4b5e647 Fix a link, shorten some headings 2020-05-19 11:47:21 +02:00
Lars Holmberg 544d31f8c8 Rework quickstart documentation (shorter, important things before less important things, etc). Moved quickstart example code into separate locustfile. Update some comments for 1.0. 2020-05-19 11:27:46 +02:00
Jonatan Heyman e40edfed6e Add config file keys to settings table in the Configuration docs.
Remove advanced configuration examples from Quickstart docs in favor of just linking to the Configuration docs.
2020-05-01 16:27:58 +02:00
Jonatan Heyman 5c0cf6b963
Merge pull request #1359 from Edrolo/config-argument
Add --config command line argument
2020-05-01 15:55:14 +02:00
Jonatan Heyman 265a3bfce9 Update python references in documentation and docstrings after code restructuring of core.py (#1361).
Change so that we refer to classes/functions through the `locust.*` namespace, since this will allow us to do other code restructuring changes without having to update docstrings and docs.
2020-05-01 12:27:54 +02:00
Matt Fisher 8ce5129c74 Docs for --config command line argument 2020-04-30 18:38:32 +10:00
Jonatan Heyman 97491e4f3c * Explicitly set environment variable names for command line options.
* Automatically generate documentation for all available environment variables.
* Rename env variables LOCUST_MASTER, LOCUST_MASTER_PORT in order to make it less likely that they collide with env vars automatically added by Kubernetes. Also change the name of LOCUST_WORKER and LOCUST_MASTER_HOST for consistency.
* Rename env variable CSVFILEBASE to LOCUST_CSV.
* Remove --csv-base-name command line option.
2020-04-28 18:41:53 +02:00
anuj_ de53ef8cf7 documentation updated 2020-04-20 14:54:28 +12:00
Jonatan Heyman 1bdbcdbb65 Add an additional client.get() call to first example in the Quickstart documentation. Hopefully that will show that tasks are not restricted to only a single get() call. 2020-04-17 14:40:09 +02:00