Skip to content

Commit f7b8aa2

Browse files
authored
Merge pull request #227 from tableau/minor-cleanup
Minor doc improvements
2 parents cff1e58 + 4dfe23b commit f7b8aa2

File tree

5 files changed

+25
-26
lines changed

5 files changed

+25
-26
lines changed

README

-1
This file was deleted.

README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,14 @@ This repo contains Python source and example files for the Tableau Document API.
55

66
For more information, see the documentation:
77

8-
<http://tableau.github.io/document-api-python>
8+
<https://tableau.github.io/document-api-python>
99

1010
Document API
1111
---------------
1212
The Document API provides a supported way to programmatically make updates to Tableau workbook and data source files. If you've been making changes to these file types by directly updating the XML--that is, by XML hacking--this SDK is for you :)
1313

1414
Features include:
15-
- Support for 9.X, 10.X and 202x.x workbook and data source files
16-
- Including TDSX and TWBX files
15+
- Support for TWB, TWBX, TDE and TDSX files starting roughly back to Tableau 9.x
1716
- Getting connection information from data sources and workbooks
1817
- Server Name
1918
- Username
@@ -28,6 +27,8 @@ Features include:
2827
- Get all fields in a data source
2928
- Get all fields in use by certain sheets in a workbook
3029

30+
For Hyper files, take a look a the [Tableau Hyper API](https://help.tableau.com/current/api/hyper_api/en-us/index.html).
31+
3132
We don't yet support creating files from scratch, adding extracts into workbooks or data sources, or updating field information
3233

3334
As of 2021, this SDK no longer supports Python 2.

docs/_includes/header.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
<ul class="nav navbar-nav">
1616
<li><a href="{{ site.baseurl }}/docs/">Docs</a></li>
1717
<li><a href="{{ site.baseurl }}/docs/api-ref">API Reference</a></li>
18-
<li><a target="_blank" href="https://community.tableau.com/community/developers/content">Forum</a></li>
18+
<li><a target="_blank" href="https://community.tableau.com/s/topic/0TO4T000000QF8eWAG/developers-apis">Forum</a></li>
1919
<!-- <li><a href="{{ site.baseurl }}/news/">What's New?</a></li> -->
2020
</ul>
2121
<ul class="nav navbar-nav navbar-right">

docs/docs/contributing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ a feature do not require the CLA.
1919

2020
## Issues and Feature Requests
2121

22-
To submit an issue/bug report, or to request a feature, please submit a [github issue](https://github.com/tableau/document-api-python/issues) to the repo.
22+
To submit an issue/bug report, or to request a feature, please submit a [GitHub issue](https://github.com/tableau/document-api-python/issues) to the repo.
2323

2424
If you are submitting a bug report, please provide as much information as you can, including clear and concise repro steps, attaching any necessary
2525
files to assist in the repro. **Be sure to scrub the files of any potentially sensitive information. Issues are public.**

docs/index.md

+19-20
Original file line numberDiff line numberDiff line change
@@ -7,32 +7,31 @@ layout: home
77
<p>This site will get you up and running with the Python version of the Tableau Document API. The Document API, including the samples and documentation, are all open source.</p>
88
<br />
99
<a class="btn btn-primary btn-lg" href="{{ site.baseurl }}/docs" role="button">Get Started</a>&nbsp;&nbsp;
10-
<a class="btn btn-primary btn-lg" href="https://github.com/tableau/document-api-python/archive/v0.4.0.zip" role="button">Download</a>
10+
<a class="btn btn-primary btn-lg" href="https://github.com/tableau/document-api-python/releases" role="button">Download</a>
1111
</header>
1212

1313
# Document API Overview
14-
This repo contains Python source and example files for the Tableau Document API. We're just getting started and have plans to expand what you find here. Help us by submitting feedback, issues, and pull requests!
15-
14+
This repo contains Python source and example files for the Tableau Document API.
1615

1716
The Document API provides a supported way to programmatically make updates to Tableau workbook and data source files. If you've been making changes to these file types by directly updating the XML--that is, by XML hacking--this SDK is for you.
1817

18+
Features include:
19+
20+
- Support for TWB, TWBX, TDE and TDSX files starting roughly back to Tableau 9.x
21+
- Getting connection information from data sources and workbooks
22+
- Server Name
23+
- Username
24+
- Database Name
25+
- Authentication Type
26+
- Connection Type
27+
- Updating connection information in workbooks and data sources
28+
- Server Name
29+
- Username
30+
- Database Name
31+
- Getting Field information from data sources and workbooks
32+
- Get all fields in a data source
33+
- Get all fields in use by certain sheets in a workbook
1934

20-
>Features include:
21-
>
22-
>- Support for 9.X, and 10.X workbook and data source files
23-
> - Including TDSX and TWBX files
24-
>- Getting connection information from data sources and workbooks
25-
> - Server Name
26-
> - Username
27-
> - Database Name
28-
> - Authentication Type
29-
> - Connection Type
30-
>- Updating connection information in workbooks and data sources
31-
> - Server Name
32-
> - Username
33-
> - Database Name
34-
>- Getting Field information from data sources and workbooks
35-
> - Get all fields in a data source
36-
> - Get all fields in use by certain sheets in a workbook
35+
For Hyper files, take a look a the [Tableau Hyper API](https://help.tableau.com/current/api/hyper_api/en-us/index.html).
3736

3837
We don't yet support creating files from scratch, adding extracts into workbooks or data sources, or updating field information.

0 commit comments

Comments
 (0)