ソースを参照

Update documentation links (#4541)

* Update vertx-web

* Update documenation links

* remove install.sh info from language readmes
Nate 6 年 前
コミット
4322cacaef
42 ファイル変更40 行追加272 行削除
  1. 1 1
      frameworks/CSharp/README.md
  2. 1 1
      frameworks/CSharp/nancy/README.md
  3. 1 18
      frameworks/Java/README.md
  4. 0 103
      frameworks/PHP/README.md
  5. 0 19
      frameworks/Perl/README.md
  6. 2 27
      frameworks/Python/README.md
  7. 1 1
      frameworks/Python/aiohttp/README.md
  8. 1 1
      frameworks/Python/api_hour/README.md
  9. 1 1
      frameworks/Python/blacksheep/README.md
  10. 1 1
      frameworks/Python/bottle/README.md
  11. 1 1
      frameworks/Python/django/README.md
  12. 1 1
      frameworks/Python/falcon/README.md
  13. 1 1
      frameworks/Python/fastapi/README.md
  14. 1 1
      frameworks/Python/flask/README.md
  15. 1 1
      frameworks/Python/japronto/README.md
  16. 1 1
      frameworks/Python/klein/README.md
  17. 1 1
      frameworks/Python/morepath/README.md
  18. 1 1
      frameworks/Python/pyramid/README.md
  19. 1 1
      frameworks/Python/responder/README.md
  20. 1 1
      frameworks/Python/sanic/README.md
  21. 1 1
      frameworks/Python/starlette/README.md
  22. 1 1
      frameworks/Python/tornado/README.md
  23. 1 1
      frameworks/Python/uvicorn/README.md
  24. 1 1
      frameworks/Python/uwsgi/README.md
  25. 1 1
      frameworks/Python/vibora/README.md
  26. 1 1
      frameworks/Python/web2py/README.md
  27. 1 1
      frameworks/Python/weppy/README.md
  28. 1 1
      frameworks/Python/wsgi/README.md
  29. 1 55
      frameworks/Ruby/README.md
  30. 1 1
      frameworks/Ruby/grape/README.md
  31. 1 1
      frameworks/Ruby/padrino/README.md
  32. 1 1
      frameworks/Ruby/rack-sequel/README.md
  33. 1 1
      frameworks/Ruby/rack/README.md
  34. 1 1
      frameworks/Ruby/rails/README.md
  35. 1 1
      frameworks/Ruby/roda-sequel/README.md
  36. 1 1
      frameworks/Ruby/sinatra-sequel/README.md
  37. 1 1
      frameworks/Ruby/sinatra/README.md
  38. 1 1
      frameworks/Scala/akka-http/akka-http/src/main/scala/com/typesafe/akka/http/benchmark/handlers/PlaintextHandler.scala
  39. 0 14
      frameworks/Swift/README.md
  40. 1 1
      frameworks/VB/README.md
  41. 1 1
      toolset/benchmark/framework_test.py
  42. 1 1
      toolset/scaffolding/README.md

+ 1 - 1
frameworks/CSharp/README.md

@@ -2,7 +2,7 @@
 
 
 The information below contains information specific to C#. 
 The information below contains information specific to C#. 
 For further guidance, review the 
 For further guidance, review the 
-[documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/).
+[documentation](https://github.com/TechEmpower/FrameworkBenchmarks/wiki).
 
 
 ## Infrastructure Software Versions
 ## Infrastructure Software Versions
 
 

+ 1 - 1
frameworks/CSharp/nancy/README.md

@@ -2,7 +2,7 @@
 
 
 The information below contains information specific to Nancy on Mono and CoreCLR. 
 The information below contains information specific to Nancy on Mono and CoreCLR. 
 For further guidance, review the 
 For further guidance, review the 
-[documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/). 
+[documentation](https://github.com/TechEmpower/FrameworkBenchmarks/wiki). 
 Also note the additional information provided in the [CSharp README](../).
 Also note the additional information provided in the [CSharp README](../).
 
 
 This is the Nancy on Mono and CoreCLR portion of a [benchmarking test suite](../../) 
 This is the Nancy on Mono and CoreCLR portion of a [benchmarking test suite](../../) 

+ 1 - 18
frameworks/Java/README.md

@@ -2,24 +2,7 @@
 
 
 The information below contains information specific to Java. 
 The information below contains information specific to Java. 
 For further guidance, review the 
 For further guidance, review the 
-[documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/).
-
-## Infrastructure Software Versions
-
-* Java 8
-
-## Adding a New Java Framework
-
-### Installation and Bash Configuration
-
-In order to declare that your framework requires Java, you 
-should have an `install.sh` that contains at least
-
-    #!/bin/bash
-
-    fw_depends java
-
-This installs the Oracle Java 8 JDK.
+[documentation](https://github.com/TechEmpower/FrameworkBenchmarks/wiki).
 
 
 ## Get Help
 ## Get Help
 
 

+ 0 - 103
frameworks/PHP/README.md

@@ -53,115 +53,12 @@ easier to use systems such as APCu.
 
 
 Ask if you are not certain.
 Ask if you are not certain.
 
 
-## Install.sh and Setup.sh Files
-
-Most PHP frameworks use `fw_depends php5 nginx composer` in their `install.sh` file, 
-which installs PHP5, Nginx, and Composer automatically. They then create a `setup.sh`
-containing these lines (comments added to clarify what's happening). `fw_depends php7` is now also available.
-
-    # Explanation of variables provided by toolset:
-    #   FWROOT - absolute path to framework toolset, normally 
-    #            something like /home/username/FrameworkBenchmarks
-    #   TROOT  - absolute path to this framework's folder, normally
-    #            something like /home/username/FrameworkBenchmarks/frameworks/PHP/cakephp
-    #   IROOT  - absolute path to the location where the toolset has installed software, 
-    #            something like /home/username/FrameworkBenchmarks/installs
-    #
-    # As of writing fw_depends installs 5.5.17 into the installer root
-    export PHP_HOME=${IROOT}/php-5.5.17
-    export PHP_FPM=$PHP_HOME/sbin/php-fpm
-    export NGINX_HOME=${IROOT}/nginx
-    
-    # Uses the full path to php-fpm
-    #   - php-fpm configuration is located in the config folder found in the 
-    #     root of this project
-    #   - We tell PHP-FPM to place it's PID file into the deploy folder
-    $PHP_FPM --fpm-config $FWROOT/toolset/setup/linux/languages/php/php-fpm.conf -g $TROOT/deploy/php-fpm.pid
-    # Turn on nginx using the configuration file found in this framework's deploy
-    # folder
-    $NGINX_HOME/sbin/nginx -c $TROOT/deploy/nginx.conf
-
-When using `php`, `php-fpm`, or other binaries, always use the full path 
-to the binary, e.g. instead of `php <command>`, 
-use `/home/foo/FrameworkBenchmarks/installs/php-5.5.17/bin/php <your command>`. 
-
 ### Dependency Management Using Composer
 ### Dependency Management Using Composer
 
 
 Many PHP apps use [Composer](https://getcomposer.org/) for dependency management, 
 Many PHP apps use [Composer](https://getcomposer.org/) for dependency management, 
 which greatly simplifies downloading the framework, loading the framework, and 
 which greatly simplifies downloading the framework, loading the framework, and 
 upgrading the framework version in the future. 
 upgrading the framework version in the future. 
 
 
-There are two main guidelines for PHP frameworks: 
-
-* **Never include the source code for your framework into this repository.** Download it 
-using Composer, wget, or some other tool
-* **When using Composer, always add a `composer.lock` file in addition to the `composer.json` file**. 
-The lock file is a fully-defined file generated by composer 1) reading your JSON file 2) finding all 
-dependencies 3) downloading a lot of data from Github. Without this lock file, composer takes 2-3x 
-longer to run, and it can even halt and require user input
-
-#### Setting up Composer
-
-Add a `composer.json` file to your framework's root folder, e.g. `php-fuel/composer.json`. 
-Ensure your `setup.sh` lists composer as a dependency.
-
-    # Note the order! Composer depends on PHP so it has to be defined after
-    fw_depends mysql php7 nginx composer
-
-The `composer install` command will run automatically using the following flags: `--no-dev --no-interaction --no-progress --no-suggest --optimize-autoloader --classmap-authoritative`
-
-After the installation completes, your framework folder will have a new `vendor` folder, 
-e.g. `php-fuel/vendor` that contains all dependencies. Update your PHP scripts
-to either directly reference files inside of vendor, or use the `vendor/autoload.php`
-file. 
-
-#### Generating composer.lock file
-
-Composer uses Github *a lot*, enough so that it is common for it to exceed the 
-API limit and cause infinite hangs or installation failures. To avoid this, it 
-is necessary to generate a `composer.lock` file. If you're lucky, you can run 
-`toolset/run-tests.py --install server --test <your framework> --install-only`,
-which will run your `install.sh` file and leave the `composer.lock` file right
-next to your `composer.json` file. If this works, just add the lock file to 
-the repository and you're done. There is more info on this [here](https://getcomposer.org/doc/03-cli.md#install)
-and [here](https://circleci.com/docs/composer-api-rate-limit)
-
-*Note:* You may have to force-add the lock file (e.g. `git add -f composer.lock`), 
-because some gitignore files in this repo contain `*.lock` to avoid Ruby's lock files. 
-
-If you are prompted for input during the `run-tests.py` script above, then you
-need to generate your lock file manually so that you may answer the input 
-queries as they are shown. Use these steps
-    
-    # Define the environment variables you need (modify as needed)
-    export IROOT=/home/you/FrameworkBenchmarks/installs
-    export TROOT=/home/you/FrameworkBenchmarks/frameworks/PHP/php-yii2
-    
-    # Run the installation shown above
-    #
-    # This will manually prompt you for your Github credentials 
-    # to avoid the Github rate limit
-    # When this command completes, you will have a lock file 
-    ${IROOT}/php-5.5.17/bin/php ${COMPOSER_HOME}/composer.phar install \
-      --working-dir $TROOT
-    
-    # Add the lock file to this repository
-    git add -f composer.lock
-
-#### Updating Composer setup
-
-If you update `composer.json`, you need to regenerate the lock
-file. If you forget to do this, you will see this error message 
-when running:
-
-    Warning: The lock file is not up to date with the latest changes in composer.json. You may be getting outdated dependencies. Run update to update them.
-
-### Debugging PHP Frameworks
-
-The first stop for HTTP 500 errors is to enable stack traces. 
-Update `toolset/setup/linux/languages/php/php-fpm.conf` to include `php_flag[display_errors] = on`. 
-If you don't use php-fpm, update the `config/php.ini`
-
 ## Get Help
 ## Get Help
 
 
 ### PHP Experts
 ### PHP Experts

+ 0 - 19
frameworks/Perl/README.md

@@ -1,22 +1,3 @@
-# Installation and Bash Configuration
-
-In order to declare that your framework requires Perl, you should have an `install.sh`
-that contains at least
-
-    #!/bin/bash
-    export PERL_HOME=${IROOT}/perl-5.18
-    export PATH="$PERL_HOME/bin:$PATH"
-
-    fw_depends perl
-
-This installs the Perl interpreter and some basic modules (see Dependency Management).
-The `install.sh` file should then install any required perl modules or other supporting
-applications.
-
-Perl is installed in the `$IROOT` directory. Currently, the Perl interpreter
-used by the test is in version 5.18 family. This will provide the `$PERL_HOME` path - should you need it - and 
-allow all apps installed by Perl to be used directly.
-
 # Dependency Management
 # Dependency Management
 
 
 While installing Perl, the [`cpanm`](https://metacpan.org/pod/distribution/App-cpanminus/bin/cpanm)
 While installing Perl, the [`cpanm`](https://metacpan.org/pod/distribution/App-cpanminus/bin/cpanm)

+ 2 - 27
frameworks/Python/README.md

@@ -2,7 +2,7 @@
 
 
 The information below contains information specific to Python. 
 The information below contains information specific to Python. 
 For further guidance, review the 
 For further guidance, review the 
-[documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/).
+[documentation](https://github.com/TechEmpower/FrameworkBenchmarks/wiki).
 
 
 ## Infrastructure Software Versions
 ## Infrastructure Software Versions
 
 
@@ -99,29 +99,4 @@ If your framework uses SQLAlchemy, Flask may be enough to know performance of SQ
 
 
 ### Interpreter
 ### Interpreter
 
 
-Consider Python 3 first. -- Python 3 is mainstream for web development.
-
-### Server
-
-Try Gunicorn + Meinheld first. All WSGI apps in this benchmark uses it. You can compare
-your framework performance with others.
-
-### Files you should provide
-
-You can see Flask's files to know how to write new test.
-
-`requirements.txt` is standard way to define depending libraries.
-
-`install.sh` is executed before running test.  You should create virtualenv on `$TROOT/py2`
-(or py3 for Python 3 and pypy for PyPy).  Then `$TROOT/py2/bin/pip install -r requirements.txt`.
-virtualenv is installed on Python 2 and PyPy.  Use `$IROOT/py3/bin/python3 -m venv $TROOT/py3`
-for Python 3.
-
-You can set environment variables within `install.sh` or within `setup.sh`.
-
-`bechmark_config` is json file to define test.
-See [here](http://frameworkbenchmarks.readthedocs.org/en/latest/Codebase/Framework-Files/#benchmark-config-file).
-
-`setup_py2.sh` is used to run test on Python 2.  `gunicorn_conf.py` is configuration for gunicorn.
-`setup_py2.sh` and `gunicorn_conf.py` are written as generic as possible.
-You may be able to use it with changing wsgi callable.  (`$PY2_GUNICORN wsgimodule:callable -c gunicorn_conf.py`)
+Consider Python 3 first. -- Python 3 is mainstream for web development.

+ 1 - 1
frameworks/Python/aiohttp/README.md

@@ -1,7 +1,7 @@
 # [aiohttp](http://aiohttp.readthedocs.io/) Benchmark Test
 # [aiohttp](http://aiohttp.readthedocs.io/) Benchmark Test
 
 
 The information below is specific to aiohttp. For further guidance, 
 The information below is specific to aiohttp. For further guidance, 
-review the [documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/). 
+review the [documentation](https://github.com/TechEmpower/FrameworkBenchmarks/wiki). 
 Also note that there is additional information that's provided in 
 Also note that there is additional information that's provided in 
 the [Python README](../).
 the [Python README](../).
 
 

+ 1 - 1
frameworks/Python/api_hour/README.md

@@ -4,7 +4,7 @@ This is the AsyncIO/aiohttp/API-Hour portion of a [benchmarking tests suite](../
 comparing a variety of web development platforms.
 comparing a variety of web development platforms.
 
 
 The information below is specific to AsyncIO/API-Hour. For further guidance, 
 The information below is specific to AsyncIO/API-Hour. For further guidance, 
-review the [documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/). 
+review the [documentation](https://github.com/TechEmpower/FrameworkBenchmarks/wiki). 
 Also note that there is additional information provided in 
 Also note that there is additional information provided in 
 the [Python README](../).
 the [Python README](../).
 
 

+ 1 - 1
frameworks/Python/blacksheep/README.md

@@ -4,7 +4,7 @@ This is the BlackSheep portion of a [benchmarking tests suite](../../)
 comparing a variety of web development platforms.
 comparing a variety of web development platforms.
 
 
 The information below is specific to BlackSheep. For further guidance,
 The information below is specific to BlackSheep. For further guidance,
-review the [documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/).
+review the [documentation](https://github.com/TechEmpower/FrameworkBenchmarks/wiki).
 Also note that there is additional information provided in
 Also note that there is additional information provided in
 the [Python README](../).
 the [Python README](../).
 
 

+ 1 - 1
frameworks/Python/bottle/README.md

@@ -4,7 +4,7 @@ This is the Python Bottle portion of a [benchmarking tests suite](../../)
 comparing a variety of frameworks.
 comparing a variety of frameworks.
 
 
 The information below is specific to Bottle. For further guidance, 
 The information below is specific to Bottle. For further guidance, 
-review the [documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/). 
+review the [documentation](https://github.com/TechEmpower/FrameworkBenchmarks/wiki). 
 Also note that there is additional information that's provided in 
 Also note that there is additional information that's provided in 
 the [Python README](../).
 the [Python README](../).
 
 

+ 1 - 1
frameworks/Python/django/README.md

@@ -4,7 +4,7 @@ This is the Django portion of a [benchmarking tests suite](../../)
 comparing a variety of web development platforms.
 comparing a variety of web development platforms.
 
 
 The information below is specific to Django. For further guidance,
 The information below is specific to Django. For further guidance,
-review the [documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/).
+review the [documentation](https://github.com/TechEmpower/FrameworkBenchmarks/wiki).
 Also note that there is additional information provided in
 Also note that there is additional information provided in
 the [Python README](../).
 the [Python README](../).
 
 

+ 1 - 1
frameworks/Python/falcon/README.md

@@ -4,7 +4,7 @@ This is the Falcon portion of a [benchmarking tests suite](../../)
 comparing a variety of web development platforms.
 comparing a variety of web development platforms.
 
 
 The information below is specific to Falcon. For further guidance, 
 The information below is specific to Falcon. For further guidance, 
-review the [documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/). 
+review the [documentation](https://github.com/TechEmpower/FrameworkBenchmarks/wiki). 
 Also note that there is additional information provided in 
 Also note that there is additional information provided in 
 the [Python README](../).
 the [Python README](../).
 
 

+ 1 - 1
frameworks/Python/fastapi/README.md

@@ -4,7 +4,7 @@ This is the FastAPI portion of a [benchmarking tests suite](../../)
 comparing a variety of web development platforms.
 comparing a variety of web development platforms.
 
 
 The information below is specific to FastAPI. For further guidance,
 The information below is specific to FastAPI. For further guidance,
-review the [documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/).
+review the [documentation](https://github.com/TechEmpower/FrameworkBenchmarks/wiki).
 Also note that there is additional information provided in
 Also note that there is additional information provided in
 the [Python README](../).
 the [Python README](../).
 
 

+ 1 - 1
frameworks/Python/flask/README.md

@@ -1,7 +1,7 @@
 # [Flask](http://flask.pocoo.org/) Benchmark Test
 # [Flask](http://flask.pocoo.org/) Benchmark Test
 
 
 The information below is specific to Flask. For further guidance, 
 The information below is specific to Flask. For further guidance, 
-review the [documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/). 
+review the [documentation](https://github.com/TechEmpower/FrameworkBenchmarks/wiki). 
 Also note that there is additional information that's provided in 
 Also note that there is additional information that's provided in 
 the [Python README](../).
 the [Python README](../).
 
 

+ 1 - 1
frameworks/Python/japronto/README.md

@@ -4,7 +4,7 @@ This is the Japronto portion of a [benchmarking tests suite](../../)
 comparing a variety of web development platforms.
 comparing a variety of web development platforms.
 
 
 The information below is specific to Japronto. For further guidance,
 The information below is specific to Japronto. For further guidance,
-review the [documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/).
+review the [documentation](https://github.com/TechEmpower/FrameworkBenchmarks/wiki).
 Also note that there is additional information provided in
 Also note that there is additional information provided in
 the [Python README](../).
 the [Python README](../).
 
 

+ 1 - 1
frameworks/Python/klein/README.md

@@ -4,7 +4,7 @@ This is the Klein portion of a [benchmarking tests suite](../../)
 comparing a variety of web development platforms.
 comparing a variety of web development platforms.
 
 
 The information below is specific to Klein. For further guidance, 
 The information below is specific to Klein. For further guidance, 
-review the [documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/). 
+review the [documentation](https://github.com/TechEmpower/FrameworkBenchmarks/wiki). 
 Also note that there is additional information provided in 
 Also note that there is additional information provided in 
 the [Python README](../).
 the [Python README](../).
 
 

+ 1 - 1
frameworks/Python/morepath/README.md

@@ -1,7 +1,7 @@
 # [Morepath](http://morepath.readthedocs.io/) Benchmark Test
 # [Morepath](http://morepath.readthedocs.io/) Benchmark Test
 
 
 The information below is specific to Morepath. For further guidance,
 The information below is specific to Morepath. For further guidance,
-review the [documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/).
+review the [documentation](https://github.com/TechEmpower/FrameworkBenchmarks/wiki).
 Also note that there is additional information that's provided in
 Also note that there is additional information that's provided in
 the [Python README](../).
 the [Python README](../).
 
 

+ 1 - 1
frameworks/Python/pyramid/README.md

@@ -4,7 +4,7 @@ This is the Python Pyramid portion of a [benchmarking tests suite](../../)
 comparing a variety of frameworks.
 comparing a variety of frameworks.
 
 
 The information below is specific to Pyramid. For further guidance, 
 The information below is specific to Pyramid. For further guidance, 
-review the [documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/). 
+review the [documentation](https://github.com/TechEmpower/FrameworkBenchmarks/wiki). 
 Also note that there is additional information that's provided in 
 Also note that there is additional information that's provided in 
 the [Python README](../).
 the [Python README](../).
 
 

+ 1 - 1
frameworks/Python/responder/README.md

@@ -4,7 +4,7 @@ This is the Responder portion of a [benchmarking tests suite](../../)
 comparing a variety of web development platforms.
 comparing a variety of web development platforms.
 
 
 The information below is specific to Responser. For further guidance,
 The information below is specific to Responser. For further guidance,
-review the [documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/).
+review the [documentation](https://github.com/TechEmpower/FrameworkBenchmarks/wiki).
 Also note that there is additional information provided in
 Also note that there is additional information provided in
 the [Python README](../).
 the [Python README](../).
 
 

+ 1 - 1
frameworks/Python/sanic/README.md

@@ -4,7 +4,7 @@ This is the Sanic portion of a [benchmarking tests suite](../../)
 comparing a variety of web development platforms.
 comparing a variety of web development platforms.
 
 
 The information below is specific to Sanic. For further guidance,
 The information below is specific to Sanic. For further guidance,
-review the [documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/).
+review the [documentation](https://github.com/TechEmpower/FrameworkBenchmarks/wiki).
 Also note that there is additional information provided in
 Also note that there is additional information provided in
 the [Python README](../).
 the [Python README](../).
 
 

+ 1 - 1
frameworks/Python/starlette/README.md

@@ -4,7 +4,7 @@ This is the Starlette portion of a [benchmarking tests suite](../../)
 comparing a variety of web development platforms.
 comparing a variety of web development platforms.
 
 
 The information below is specific to Starlette. For further guidance,
 The information below is specific to Starlette. For further guidance,
-review the [documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/).
+review the [documentation](https://github.com/TechEmpower/FrameworkBenchmarks/wiki).
 Also note that there is additional information provided in
 Also note that there is additional information provided in
 the [Python README](../).
 the [Python README](../).
 
 

+ 1 - 1
frameworks/Python/tornado/README.md

@@ -4,7 +4,7 @@ This is the Tornado portion of a [benchmarking tests suite](../../)
 comparing a variety of web development platforms.
 comparing a variety of web development platforms.
 
 
 The information below is specific to Tornado. For further guidance, 
 The information below is specific to Tornado. For further guidance, 
-review the [documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/). 
+review the [documentation](https://github.com/TechEmpower/FrameworkBenchmarks/wiki). 
 Also note that there is additional information that's provided in 
 Also note that there is additional information that's provided in 
 the [Python README](../).
 the [Python README](../).
 
 

+ 1 - 1
frameworks/Python/uvicorn/README.md

@@ -4,7 +4,7 @@ This is the Uvicorn portion of a [benchmarking tests suite](../../)
 comparing a variety of web development platforms.
 comparing a variety of web development platforms.
 
 
 The information below is specific to Uvicorn. For further guidance,
 The information below is specific to Uvicorn. For further guidance,
-review the [documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/).
+review the [documentation](https://github.com/TechEmpower/FrameworkBenchmarks/wiki).
 Also note that there is additional information provided in
 Also note that there is additional information provided in
 the [Python README](../).
 the [Python README](../).
 
 

+ 1 - 1
frameworks/Python/uwsgi/README.md

@@ -4,7 +4,7 @@ This is the UWSGI portion of a [benchmarking tests suite](../../)
 comparing a variety of web development platforms.
 comparing a variety of web development platforms.
 
 
 The information below is specific to UWSGI. For further guidance, 
 The information below is specific to UWSGI. For further guidance, 
-review the [documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/). 
+review the [documentation](https://github.com/TechEmpower/FrameworkBenchmarks/wiki). 
 Also note that there is additional information provided in 
 Also note that there is additional information provided in 
 the [Python README](../).
 the [Python README](../).
 
 

+ 1 - 1
frameworks/Python/vibora/README.md

@@ -1,7 +1,7 @@
 # [Vibora](https://github.com/vibora-io/vibora) Benchmark Test
 # [Vibora](https://github.com/vibora-io/vibora) Benchmark Test
 
 
 The information below is specific to Vibora. For further guidance, 
 The information below is specific to Vibora. For further guidance, 
-review the [documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/). 
+review the [documentation](https://github.com/TechEmpower/FrameworkBenchmarks/wiki). 
 Also note that there is additional information that's provided in 
 Also note that there is additional information that's provided in 
 the [Python README](../).
 the [Python README](../).
 
 

+ 1 - 1
frameworks/Python/web2py/README.md

@@ -4,7 +4,7 @@ This is the web2py portion of a [benchmarking tests suite](../../)
 comparing a variety of web development platforms.
 comparing a variety of web development platforms.
 
 
 The information below is specific to web2py. For further guidance,
 The information below is specific to web2py. For further guidance,
-review the [documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/).
+review the [documentation](https://github.com/TechEmpower/FrameworkBenchmarks/wiki).
 Also note that there is additional information provided in
 Also note that there is additional information provided in
 the [Python README](../).
 the [Python README](../).
 
 

+ 1 - 1
frameworks/Python/weppy/README.md

@@ -4,7 +4,7 @@ This is the weppy portion of a [benchmarking tests suite](../../)
 comparing a variety of web development platforms.
 comparing a variety of web development platforms.
 
 
 The information below is specific to weppy. For further guidance, 
 The information below is specific to weppy. For further guidance, 
-review the [documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/). 
+review the [documentation](https://github.com/TechEmpower/FrameworkBenchmarks/wiki). 
 Also note that there is additional information provided in 
 Also note that there is additional information provided in 
 the [Python README](../).
 the [Python README](../).
 
 

+ 1 - 1
frameworks/Python/wsgi/README.md

@@ -4,7 +4,7 @@ This is the WSGI portion of a [benchmarking tests suite](../../)
 comparing a variety of web development platforms.
 comparing a variety of web development platforms.
 
 
 The information below is specific to WSGI. For further guidance, 
 The information below is specific to WSGI. For further guidance, 
-review the [documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/). 
+review the [documentation](https://github.com/TechEmpower/FrameworkBenchmarks/wiki). 
 Also note that there is additional information provided in 
 Also note that there is additional information provided in 
 the [Python README](../).
 the [Python README](../).
 
 

+ 1 - 55
frameworks/Ruby/README.md

@@ -2,61 +2,7 @@
 
 
 The information below contains information specific to Ruby. 
 The information below contains information specific to Ruby. 
 For further guidance, review the 
 For further guidance, review the 
-[documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/).
-
-## Infrastructure Software Versions
-
-* [RVM 2.2.1](https://rvm.io/) (Unless tests are run in Travis-CI)
-
-## Adding a New Ruby Framework
-
-### Installation
-
-TFB uses rvm wherever possible to help ruby-based or
-jruby-based frameworks setup their environment. 
-
-When verifying the tests in Travis-CI we rely on Travis-CI's 
-RVM installation (and $HOME isn't /home/travis while running 
-Travis-CI), so we have certain specific caveats to keep 
-Travis-CI happy.
-
-#### Install RVM
-
-Most install.sh files will at least have this:
-
-    #!/bin/bash
-
-    fw_depends rvm # This installs RVM
-
-    if [ "$TRAVIS" = "true" ]
-    then
-      rvmsudo rvm install ruby-2.0.0-p0
-    else
-      rvm install ruby-2.0.0-p0
-    fi
-
-### Set Up with RVM
-
-At the top of your framework's `setup.sh`, put this (if 
-you're using RVM): 
-
-    #!/bin/bash
-
-    # Assume single-user installation
-    if [ "$TRAVIS" = "true" ]
-    then
-      source /home/travis/.rvm/scripts/rvm
-    else
-      source $HOME/.rvm/scripts/rvm
-    fi
-
-Because TFB uses Python's `subprocess` module, which runs 
-all shell processes in a non-login mode, you must source the 
-`rvm` script before using `rvm` anywhere. 
-
-For compatibility with how the framework rounds are executed, 
-you must use a single-user installation if you wish to run 
-ruby-based TFB tests.
+[documentation](https://github.com/TechEmpower/FrameworkBenchmarks/wiki).
 
 
 ## Get Help
 ## Get Help
 
 

+ 1 - 1
frameworks/Ruby/grape/README.md

@@ -2,7 +2,7 @@
 
 
 The information below contains information specific to Grape.
 The information below contains information specific to Grape.
 For further guidance, review the
 For further guidance, review the
-[documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/).
+[documentation](https://github.com/TechEmpower/FrameworkBenchmarks/wiki).
 Also note the additional information provided in the [Ruby README](../).
 Also note the additional information provided in the [Ruby README](../).
 
 
 This is the Ruby Grape portion of a [benchmarking test suite](../../)
 This is the Ruby Grape portion of a [benchmarking test suite](../../)

+ 1 - 1
frameworks/Ruby/padrino/README.md

@@ -2,7 +2,7 @@
 
 
 The information below contains information specific to Padrino.
 The information below contains information specific to Padrino.
 For further guidance, review the
 For further guidance, review the
-[documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/).
+[documentation](https://github.com/TechEmpower/FrameworkBenchmarks/wiki).
 Also note the additional information provided in the [Ruby README](../).
 Also note the additional information provided in the [Ruby README](../).
 
 
 This is the Ruby Padrino portion of a [benchmarking test suite](../../)
 This is the Ruby Padrino portion of a [benchmarking test suite](../../)

+ 1 - 1
frameworks/Ruby/rack-sequel/README.md

@@ -2,7 +2,7 @@
 
 
 The information below contains information specific to the Sequel rewrite of
 The information below contains information specific to the Sequel rewrite of
 the Rack benchmarking test. For further guidance, review the
 the Rack benchmarking test. For further guidance, review the
-[documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/).  Also
+[documentation](https://github.com/TechEmpower/FrameworkBenchmarks/wiki).  Also
 note the additional information provided in the [Ruby README](../).
 note the additional information provided in the [Ruby README](../).
 
 
 This is the Ruby Rack portion of a [benchmarking test suite](../../) comparing
 This is the Ruby Rack portion of a [benchmarking test suite](../../) comparing

+ 1 - 1
frameworks/Ruby/rack/README.md

@@ -2,7 +2,7 @@
 
 
 The information below contains information specific to Rack.
 The information below contains information specific to Rack.
 For further guidance, review the
 For further guidance, review the
-[documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/).
+[documentation](https://github.com/TechEmpower/FrameworkBenchmarks/wiki).
 Also note the additional information provided in the [Ruby README](../).
 Also note the additional information provided in the [Ruby README](../).
 
 
 This is the Ruby Rack portion of a [benchmarking test suite](../../)
 This is the Ruby Rack portion of a [benchmarking test suite](../../)

+ 1 - 1
frameworks/Ruby/rails/README.md

@@ -2,7 +2,7 @@
 
 
 The information below contains information specific to Ruby on Rails.
 The information below contains information specific to Ruby on Rails.
 For further guidance, review the
 For further guidance, review the
-[documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/).
+[documentation](https://github.com/TechEmpower/FrameworkBenchmarks/wiki).
 Also note the additional information provided in the [Ruby README](../).
 Also note the additional information provided in the [Ruby README](../).
 
 
 This is the Ruby on Rails portion of a [benchmarking test suite](../../)
 This is the Ruby on Rails portion of a [benchmarking test suite](../../)

+ 1 - 1
frameworks/Ruby/roda-sequel/README.md

@@ -2,7 +2,7 @@
 
 
 The information below contains information specific to the Roda benchmarking
 The information below contains information specific to the Roda benchmarking
 test. For further guidance, review the
 test. For further guidance, review the
-[documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/). Also
+[documentation](https://github.com/TechEmpower/FrameworkBenchmarks/wiki). Also
 note the additional information provided in the [Ruby README](../).
 note the additional information provided in the [Ruby README](../).
 
 
 This is the Ruby Roda portion of a [benchmarking test suite](../../)
 This is the Ruby Roda portion of a [benchmarking test suite](../../)

+ 1 - 1
frameworks/Ruby/sinatra-sequel/README.md

@@ -2,7 +2,7 @@
 
 
 The information below contains information specific to the Sequel rewrite of
 The information below contains information specific to the Sequel rewrite of
 the Sinatra benchmarking test. For further guidance, review the
 the Sinatra benchmarking test. For further guidance, review the
-[documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/).  Also
+[documentation](https://github.com/TechEmpower/FrameworkBenchmarks/wiki).  Also
 note the additional information provided in the [Ruby README](../).
 note the additional information provided in the [Ruby README](../).
 
 
 This is the Ruby Sinatra portion of a [benchmarking test suite](../../)
 This is the Ruby Sinatra portion of a [benchmarking test suite](../../)

+ 1 - 1
frameworks/Ruby/sinatra/README.md

@@ -2,7 +2,7 @@
 
 
 The information below contains information specific to the Sinatra benchmarking
 The information below contains information specific to the Sinatra benchmarking
 test. For further guidance, review the
 test. For further guidance, review the
-[documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/).  Also
+[documentation](https://github.com/TechEmpower/FrameworkBenchmarks/wiki).  Also
 note the additional information provided in the [Ruby README](../).
 note the additional information provided in the [Ruby README](../).
 
 
 This is the Ruby Sinatra portion of a [benchmarking test suite](../../)
 This is the Ruby Sinatra portion of a [benchmarking test suite](../../)

+ 1 - 1
frameworks/Scala/akka-http/akka-http/src/main/scala/com/typesafe/akka/http/benchmark/handlers/PlaintextHandler.scala

@@ -10,7 +10,7 @@ import akka.http.scaladsl.server.Route
 trait PlaintextHandler {
 trait PlaintextHandler {
   // akka-http will always generate a charset parameter for text/plain, so to be competitive, we create a custom
   // akka-http will always generate a charset parameter for text/plain, so to be competitive, we create a custom
   // one here to save a few bytes of headers for this particular test case. This is explicitly allowed in:
   // one here to save a few bytes of headers for this particular test case. This is explicitly allowed in:
-  // http://frameworkbenchmarks.readthedocs.org/en/latest/Project-Information/Framework-Tests/#specific-test-requirements
+  // https://github.com/TechEmpower/FrameworkBenchmarks/wiki/Project-Information-Framework-Tests-Overview#specific-test-requirements
   val plainTextResponse = HttpResponse(entity = HttpEntity(MediaType.customWithFixedCharset("text", "plain", `UTF-8`), "Hello, World!"))
   val plainTextResponse = HttpResponse(entity = HttpEntity(MediaType.customWithFixedCharset("text", "plain", `UTF-8`), "Hello, World!"))
 
 
   def plainTextEndpoint: Route =
   def plainTextEndpoint: Route =

+ 0 - 14
frameworks/Swift/README.md

@@ -6,19 +6,5 @@ The information below contains information specific to Python. For further guida
 
 
 [Swift](https://swift.org)
 [Swift](https://swift.org)
 
 
-## Adding a New Framework
-
-In order to declare that your framework requires Swift, you should have an `install.sh` that contains at least
-```
-#!/bin/bash
-
-fw_depends swift
-
-```
-
-This installs Swift.
-
-## Get Help
-
 ### Swift Experts
 ### Swift Experts
 No experts listed, yet. If you're an expert, add yourself!
 No experts listed, yet. If you're an expert, add yourself!

+ 1 - 1
frameworks/VB/README.md

@@ -2,7 +2,7 @@
 
 
 The information below contains information specific to VB. 
 The information below contains information specific to VB. 
 For further guidance, review the 
 For further guidance, review the 
-[documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/).
+[documentation](https://github.com/TechEmpower/FrameworkBenchmarks/wiki).
 
 
 ## Infrastructure Software Versions
 ## Infrastructure Software Versions
 
 

+ 1 - 1
toolset/benchmark/framework_test.py

@@ -149,7 +149,7 @@ class FrameworkTest:
                     result == 'pass' for (result, reason, url) in results)
                     result == 'pass' for (result, reason, url) in results)
 
 
                 def output_result(result, reason, url):
                 def output_result(result, reason, url):
-                    specific_rules_url = "http://frameworkbenchmarks.readthedocs.org/en/latest/Project-Information/Framework-Tests/#specific-test-requirements"
+                    specific_rules_url = "https://github.com/TechEmpower/FrameworkBenchmarks/wiki/Project-Information-Framework-Tests-Overview#specific-test-requirements"
                     color = Fore.GREEN
                     color = Fore.GREEN
                     if result.upper() == "WARN":
                     if result.upper() == "WARN":
                         color = Fore.YELLOW
                         color = Fore.YELLOW

+ 1 - 1
toolset/scaffolding/README.md

@@ -34,7 +34,7 @@ Edit `.travis.yml` to ensure that Travis-CI will automatically run our verificat
 
 
 6. Fix this `README.md` and open a pull request
 6. Fix this `README.md` and open a pull request
 
 
-Starting on line 59 is your actual `README.md` that will sit with your test implementation. Update all the dummy values to their correct values so that when people visit your test in our Github repository, they will be greated with information on how your test implementation works and where to look for useful source code.
+Starting on line 49 is your actual `README.md` that will sit with your test implementation. Update all the dummy values to their correct values so that when people visit your test in our Github repository, they will be greated with information on how your test implementation works and where to look for useful source code.
 
 
 After you have the real `README.md` file in place, delete everything above line 59 and you are ready to open a pull request.
 After you have the real `README.md` file in place, delete everything above line 59 and you are ready to open a pull request.