Skip to content

Commit f1bc11a

Browse files
authored
Update developer docs (#1724)
* Remove old reference to setup.py * Update some external links * Revert "Update some external links" This reverts commit ad5b321. My editor had auto formatting on which added a bunch of unintended changes here. * Revert "Remove old reference to setup.py" This reverts commit d4c2645. My editor had auto formatting on which added a bunch of unintended changes here. * Update a few links * Update obsolete method of running tests * Expand explanation of running tests
1 parent fc4e542 commit f1bc11a

2 files changed

Lines changed: 14 additions & 7 deletions

File tree

_includes/header.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
<!-- <li><a href="{{ site.baseurl }}/news/">What's New?</a></li> -->
2020
</ul>
2121
<ul class="nav navbar-nav navbar-right">
22-
<li class="tableauIcon"><a target="_blank" href="https://tableau.com"><img src="{{ site.baseurl }}/assets/logo.png" alt="Tableau Developers" class="logo" /></a></li>
22+
<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>
2323
<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>
2424
</ul>
2525
</div>

docs/dev-guide.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ add your contributions to the **development** branch.
2121
### Get the source code and set up your branch
2222

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

2626
1. Clone your fork:
2727

@@ -42,7 +42,7 @@ add your contributions to the **development** branch.
4242
```shell
4343
git remote add upstream https://github.com/tableau/server-client-python
4444
```
45-
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).
45+
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).
4646

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

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

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

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

158+
| Test | Command |
159+
| --- | --- |
160+
| Test everything | `pytest test` |
161+
| Test everything, run in parallel | `pytest -n auto test` |
162+
| Run a specific test | `pytest test/test_user.py` |
163+
| Code coverage report | `pip install coverage` <br> `pytest --cov=tableauserverclient test` <br> `coverage html` <br> `open htmlcov/index.html` |
164+
158165
### Update the documentation
159166

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

166173
1. Make a PR as described
167-
[here](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork)
174+
[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)
168175
against the **development** branch for code changes.
169176

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

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

195202
To make changes or additions to the documentation, please create a pull request
196203
against the **gh-pages** branch. Because the docs are in a separate branch, you
@@ -212,7 +219,7 @@ To preview and run the documentation locally, these are the steps:
212219
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.
213220

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

217224
## Release process (maintainers)
218225

0 commit comments

Comments
 (0)