Skip to content

Draft: Update developer docs #1724

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bcantoni wants to merge 7 commits into
base: gh-pages
Choose a base branch
from
Open

Draft: Update developer docs #1724

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d4c2645
Remove old reference to setup.py
bcantoni Dec 23, 2025
ad5b321
Update some external links
bcantoni Dec 23, 2025
ba6bc59
Revert "Update some external links"
bcantoni Dec 23, 2025
5edab65
Revert "Remove old reference to setup.py"
bcantoni Dec 23, 2025
eee6c24
Update a few links
bcantoni Dec 23, 2025
52cd0d8
Update obsolete method of running tests
bcantoni Dec 23, 2025
6212099
Expand explanation of running tests
bcantoni Dec 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion _includes/header.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<!-- <li><a href="{{ site.baseurl }}/news/">What's New?</a></li> -->
</ul>
<ul class="nav navbar-nav navbar-right">
<li class="tableauIcon"><a target="_blank" href="https://tableau.com"><img src="{{ site.baseurl }}/assets/logo.png" alt="Tableau Developers" class="logo" /></a></li>
<li class="tableauIcon"><a target="_blank" href="https://www.tableau.com/"><img src="{{ site.baseurl }}/assets/logo.png" alt="Tableau Developers" class="logo" /></a></li>
<li><a target="_blank" href="https://github.com/tableau/server-client-python"><span class="icon icon--github" title="Tableau Server Client on GitHub" alt="Tableau Server Client on GitHub">{% include icon-github.svg %}</span></a></li>
</ul>
</div>
Expand Down
19 changes: 13 additions & 6 deletions docs/dev-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ add your contributions to the **development** branch.
### Get the source code and set up your branch

1. Fork the repository. We follow the "Fork and Pull" model as described
[here](https://help.github.com/articles/about-collaborative-development-models/).
[here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models#fork-and-pull-model).

1. Clone your fork:

Expand All @@ -42,7 +42,7 @@ add your contributions to the **development** branch.
```shell
git remote add upstream https://github.com/tableau/server-client-python
```
More information about configuring a remote for a fork can be found [here](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork).
More information about configuring a remote for a fork can be found [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/configuring-a-remote-repository-for-a-fork).

1. Sync your fork:
```shell
Expand Down Expand Up @@ -145,7 +145,7 @@ depending on how and where git is installed on your system, for example:
### Add tests

All of our tests live under the `test/` folder in the repository. We use
`pytest` and the built-in test runner `python setup.py test`.
`pytest` to run the tests.

Follow the structure of existing tests, especially if new server responses
are going to be mocked.
Expand All @@ -155,6 +155,13 @@ static file, like a .twb/.twbx/.xml, it should live under `test/assets/`

Make sure that all tests are passing before submitting your pull request.

| Test | Command |
| --- | --- |
| Test everything | `pytest test` |
| Test everything, run in parallel | `pytest -n auto test` |
| Run a specific test | `pytest test/test_user.py` |
| Code coverage report | `pip install coverage` <br> `pytest --cov=tableauserverclient test` <br> `coverage html` <br> `open htmlcov/index.html` |

### Update the documentation

When adding a new feature or improving existing functionality we ask that you
Expand All @@ -164,7 +171,7 @@ section below for details.
### Commit changes to your fork and open a pull request

1. Make a PR as described
[here](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork)
[here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)
against the **development** branch for code changes.

1. In your first pull request, the Salesforce Contributor License Agreement bot
Expand All @@ -190,7 +197,7 @@ on GitHub Pages.

All of the documentation source files can be found in `/docs` folder in the
**gh-pages** branch. The docs are hosted on the following URL:
<https://tableau.github.io/server-client-python>.
<https://tableau.github.io/server-client-python/>.

To make changes or additions to the documentation, please create a pull request
against the **gh-pages** branch. Because the docs are in a separate branch, you
Expand All @@ -212,7 +219,7 @@ To preview and run the documentation locally, these are the steps:
1. In your browser, connect to <http://127.0.0.1:4000/server-client-python/> to preview the changes. As long as the Jekyll serve process is running, it will rebuild any new file changes automatically.

For more details, see the GitHub Pages topic on
[testing locally](https://docs.github.com/en/github/working-with-github-pages/testing-your-github-pages-site-locally-with-jekyll).
[testing locally](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll).

## Release process (maintainers)

Expand Down