Merge pull request #59 from flask-dashboard/typos

Typos
flask-dashboard · Feb 28, 2018 · 095b607 · 095b607
2 parents b1fab06 + a0530d2
commit 095b607
Show file tree

Hide file tree

Showing 8 changed files with 93 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -6,10 +6,10 @@ The Flask Monitoring Dashboard provides 4 main functionalities:
 This Flask extensions finds all your endpoints.
 You can choose which endpoints you want to monitor and which not.
 Monitoring and endpoint allows you to see which endpoints are being processed quickly, and which are not.
-Additionally, it provides information about the performance of the endpoint throughout different versions.
+Additionally, it provides information about the performance of the endpoint throughout different versions and different users.
 - **Monitor your test coverage:**
 Find out what endpoints are covered by unittest. 
-For more information, see Section 'TravisCI unit testing'.
+For more information, see [this file](http://flask-monitoringdashboard.readthedocs.io/en/latest/functionality.html#test-coverage-monitoring).
 - **Collect extra information about outliers:**
 Outliers are requests that take way longer to process than regular requests.
 The dashboard stores more information about outliers, such as:
@@ -24,7 +24,7 @@ When running your app, the dashboard van be viewed by default in the route:
     [/dashboard](http://localhost:5000/dashboard)
 
 ### Status
-[![Build Status](https://travis-ci.org/flask-dashboard/Flask-Monitoring-Dashboard.svg?branch=master)](https://travis-ci.org/flask-dashboard/Flask-Monitoring-Dashboard.svg?branch=master)
+[![Build Status](https://travis-ci.org/flask-dashboard/Flask-MonitoringDashboard.svg?branch=master)](https://travis-ci.org/flask-dashboard/Flask-MonitoringDashboard.svg?branch=master)
 [![Documentation Status](https://readthedocs.org/projects/flask-monitoringdashboard/badge/?version=latest)](http://flask-monitoringdashboard.readthedocs.io/en/latest/?badge=latest)
 
 ## Installation
@@ -37,17 +37,17 @@ Or install with pip:
     pip install flask_monitoringdashboard
 
 ### Setup
-Adding the extension to your flask app is simple:
+Adding the extension to your Flask app is simple:
 
     from flask import Flask
     import flask_monitoringdashboard as dashboard
 
     app = Flask(__name__)
     dashboard.bind(app)
-
+
+## Documentation
+For a more advanced documentation, see [this site](http://flask-monitoringdashboard.readthedocs.io).
+
 ## Screenshots
 ![Screenshot 1](/docs/img/screenshot1.png)
 ![Screenshot 2](/docs/img/screenshot2.png)
-
-## Documentation
-For a more advanced documentation, see [this site](http://flask-monitoringdashboard.readthedocs.io).
diff --git a/docs/conf.py b/docs/conf.py
@@ -14,7 +14,7 @@
 
 import os
 import sys
-sys.path.insert(0, os.path.abspath('..'))	
+sys.path.insert(0, os.path.abspath('../flask-monitoringdashboard'))	
 
 
 # -- Project information -----------------------------------------------------
@@ -91,6 +91,8 @@
     'github_fork': 'https://github.com/flask-dashboard/Flask-MonitoringDashboard'
 }
 
+html_sidebars = {'**': ['globaltoc.html', 'searchbox.html', 'sourcelink.html']}
+
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".

diff --git a/docs/configuration.rst b/docs/configuration.rst
@@ -5,8 +5,8 @@ you can use the advanced features by correctly configuration the dashboard.
 
 Using a configuration file
 --------------------------
-You can use a configuration file for all options.
-This is explained in the section below.
+You can use a configuration file for all options below.
+This is explained in the following section.
 In order to configure the dashboard with the configuration-file, you can use the following function:
 
 .. code-block:: python
@@ -22,6 +22,7 @@ Thus, it becomes:
 
    app = Flask(__name__)
    dashboard.config.init_from(file='/<path to file>/config.cfg')
+   # Make sure that you first configure the dashboard, before binding it to your Flask application
    dashboard.bind(app)
    ...
 
@@ -32,7 +33,7 @@ Thus, it becomes:
    if __name__ == '__main__':
      app.run(debug=True)
 
-Instead of having a hardcoded string containing the location of the config file in the code above, it is also possible
+Instead of having a hard-coded string containing the location of the config file in the code above, it is also possible
 to define an environment variable that specifies the location of this config file.
 The line should then be:
 
@@ -107,3 +108,7 @@ This might look a bit overwhelming, but the following list explains everything i
 
      COLORS={'main':[0,97,255], 'static':[255,153,0]}
 
+What have you configured?
+-------------------------
+A lot of configuration options, but you might wonder what functionality is now supported in your Flask Monitoring Dashboard?
+Have a look at `this file <functionality.html>`_ to find the answer.
diff --git a/docs/contact.rst b/docs/contact.rst
@@ -0,0 +1,48 @@
+Contact
+=======
+In this file, you can find information to find us.
+
+Found a bug?
+------------
+Post an `issue on Github <https://github.com/flask-dashboard/Flask-MonitoringDashboard/issues>`_.
+You can use the template below for the right formatting:
+
+.. topic:: Issue Template
+
+	- Expected Behavior
+
+	  *Tell us what should happen*
+
+	- Current Behavior
+
+	  *Tell us what happens instead of the expected behavior*
+
+	- Possible Solution
+
+	  *Not obligatory, but suggest a fix/reason for the bug*
+
+	- Steps to Reproduce
+
+	  *Provide a link to a live example, or an unambiguous set of steps to reproduce this bug. Include code to reproduce, if relevant*
+
+	  1.
+
+	  2.
+
+	  3.
+
+	  4.
+
+	- Context (Environment)
+
+	  *How has this issue affected you? What are you trying to accomplish? 
+	  Providing context helps us come up with a solution that is most useful in the real world*
+
+	- Detailed Description
+
+	  *Provide a detailed description of the change or addition you are proposing*
+
+	- Possible Implementation
+
+	  *Not obligatory, but suggest an idea for implementing addition or change*
+
diff --git a/docs/functionality.rst b/docs/functionality.rst
@@ -110,15 +110,15 @@ To enable Travis to run your unit tests and send the results to the dashboard, f
 
        dependency_links=["https://github.com/flask-dashboard/Flask-MonitoringDashboard/tarball/master#egg=flask_monitoringdashboard"]
 
-       install_requires=('flask_monitoring_dashboard')
+       install_requires=('flask_monitoringdashboard')
 
 3. In your `.travis.yml` file, three script commands should be added:
 
     .. code-block:: bash
 
        export DASHBOARD_CONFIG=./config.cfg
        export DASHBOARD_LOG_DIR=./logs/
-       python -m dashboard.collect_performance
+       python -m flask_monitoringdashboard.collect_performance
 
   The config environment variable specifies where the performance collection process can find the config file.
   The log directory environment variable specifies where the performance collection process should place the logs it uses.
@@ -217,4 +217,9 @@ The 'Measurements'-tab contains the following content:
    - **Time per user:** A horizontal box plot with the execution time per user. In this graph, it is possible
      to detect if there is a difference in the execution time between users.
 
-   - **Outliers:** See Section (Outliers) above.
+   - **Outliers:** See Section (Outliers) above.
+
+Need more information?
+----------------------
+See the `contact page <contact.html>`_ to see how you can contribute on the project.
+Furthermore you can request this page for questions, bugs, or other information. 
diff --git a/docs/index.rst b/docs/index.rst
@@ -21,10 +21,12 @@ The Flask Monitoring Dashboard provides 4 main functionalities:
 - **Monitor the Flask application:**
   This Flask extensions finds all your endpoints.
   You can choose which endpoints you want to monitor and which not.
+  Monitoring and endpoint allows you to see which endpoints are being processed quickly, and which are not.
+  Additionally, it provides information about the performance of the endpoint throughout different versions and different users.
 
 - **Monitor your test coverage:**
   Find out what endpoints are covered by unittest.
-  For more information, see Section 'TravisCI unit testing'.
+  For more information, `see this file <http://flask-monitoringdashboard.readthedocs.io/en/latest/functionality.html#test-coverage-monitoring>`_.
 
 - **Collect extra information about outliers:**
   Outliers are requests that take way longer to process than regular requests.
@@ -51,12 +53,16 @@ If you are interested in the Flask Monitoring Dashboard, you can find more infor
    :maxdepth: 2
 
    installation
+
    configuration
+
    functionality
 
 Developer information
 ---------------------
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
 
+   contact
+
    changelog
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -19,12 +19,12 @@ In the former case, you're ok. In the latter, you can follow
 
 Installing a Virtual Environment (Optional)
 -------------------------------------------
-Although you don't explicitly need a Virtual Environment, it is highly recommend.
+Although you don't need a Virtual Environment, it is highly recommend.
 See `this page <https://virtualenv.pypa.io/en/stable/installation/>`_ to install a Virtual Environment.
 
 Configuring the Virtual Environment (Optional)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-If you have skipped the previous section, you can also skip this one.
+If you have skipped the previous section, you can also skip this one (since it's optional).
 Once you've installed the Virtual Environment, you need to configure it.
 This can be done by the following command:
 

diff --git a/setup.py b/setup.py
@@ -13,7 +13,7 @@ def desc():
 
 setuptools.setup(
     name="Flask-MonitoringDashboard",
-    version="1.10.2",
+    version="1.10.3",
     packages=setuptools.find_packages(),
     include_package_data=True,
     platforms='Any',
@@ -36,5 +36,11 @@ def desc():
         'Programming Language :: Python :: 3.3',
         'Programming Language :: Python :: 3.4',
         'Programming Language :: Python :: 3.5',
-        'Programming Language :: Python :: 3.6']
+        'Programming Language :: Python :: 3.6'],
+    project_urls={
+        'Bug Reports': 'https://github.com/flask-dashboard/Flask-MonitoringDashboard/issues',
+        'PyPi': 'https://pypi.org/project/Flask-MonitoringDashboard/',
+        'Documentation': 'http://flask-monitoringdashboard.readthedocs.io/',
+        'Source': 'https://github.com/flask-dashboard/Flask-MonitoringDashboard/',
+    },
 )