Clean up API documentation (tableau#420)

* Update README.md

* Doc update (tableau#402)

* Fixed broken link

* Linked to install doc.

* Dev fix spelling (tableau#408)

* Add spelling fix workflow

* Update LICENSE

update to Tableau Software LLC

* v 1.1.0: Secure /info with auth (tableau#415)

- Authorization is now required for the /info API method.
  This method did not check authentication previously. This change is
  backwards compatible with Tableau clients.

- Improved config parsing flexibility. Previously the
  TABPY_EVALUATE_TIMEOUT setting would be set to a default if
  tabpy couldn't parse the value. Now it will throw an exception
  at startup.

* Clean up API documentation

* Clean up API documentation

* Clean up API documentation

Co-authored-by: nmannheimer <[email protected]>
Co-authored-by: lriggs <[email protected]>
Co-authored-by: Olek Golovatyi <[email protected]>

.github/workflows/pull_fix_spelling.yml

@@ -0,0 +1,22 @@
+name: Fix spelling on push
+
+on: [push]
+
+jobs:
+  build:
+    name: ${{ matrix.python-version }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        python-version: [3.7]
+        os: [ubuntu-latest]
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: sobolevn/misspell-fixer-action@master
+    - uses: peter-evans/[email protected]
+      with:
+        token: ${{ secrets.GITHUB_TOKEN }}
+        commit-message: 'Fixes by misspell-fixer'
+        title: 'Typos fix by misspell-fixer'

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2016 Tableau
+Copyright (c) 2016 Tableau Software, LLC
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -15,7 +15,7 @@
 [![PyPI version](https://badge.fury.io/py/tabpy.svg)](https://pypi.python.org/pypi/tabpy/)
 ![Release](https://img.shields.io/github/release/tableau/TabPy.svg)
 
-TabPy (the Tableau Python Server) is an Analytices Extension implementation which
+TabPy (the Tableau Python Server) is an Analytics Extension implementation which
 expands Tableau's capabilities by allowing users to execute Python scripts and
 saved functions via Tableau's table calculations.
 
@@ -30,7 +30,7 @@ Consider reading TabPy documentation in the following order:
 
 Troubleshooting:
 
-* [FAQ for configuration, startup and other issues](docs/FAQ.md)
+* [TabPy Wiki](https://github.com/tableau/TabPy/wiki)
 
 More technical topics:
 

docs/TableauConfiguration.md

@@ -15,7 +15,7 @@
 
 ## Configuration
 
-Once you have a [TabPy instance](server-startup.md) set up you can easily
+Once you have a [TabPy instance](server-install.md) set up you can easily
 configure Tableau to use this service for evaluating Python code.
 
 ### Tableau Desktop

docs/server-config.md

@@ -31,7 +31,7 @@ Configuration parameters can be updated with:
 1. Adding environment variables - set the environment variable as required by
    your Operating System. When creating environment variables, use the same
    name for your environment variable as specified in the config file.
-2. Specifying a parameter in a config file (enviroment variable value overwrites
+2. Specifying a parameter in a config file (environment variable value overwrites
    configuration setting).
 
 Configuration file with custom settings is specified as a command line parameter:

docs/server-install.md

@@ -44,6 +44,6 @@ and specify it in command line:
 tabpy --config=path/to/my/config/file.conf
 ```
 
-It is highly recommended to use Python virtual enviroment for running TabPy.
+It is highly recommended to use Python virtual environment for running TabPy.
 Check the [Running TabPy in Python Virtual Environment](tabpy-virtualenv.md) page
 for more details.