Fix / update links

[bcantoni]

Found and fixed a bunch of links after running a link checker on the whole site.

[bcantoni]

@d45 for your review please.

For the fixed links I stuck with whatever style the file already had (full URL versus .md file), but we could update all of these to your style in a future PR if you want.

The only non link changes are:

• docs/trex_examples.md - fix indent so all samples line up correctly
• docs/trex_typescript.md - fix indent so that TOC appears correctly

[d45]

@bcantoni Thanks for running the link checker and making the fixes! The changes look good.
Which link checker did you use? (wc3?)
I'd like to incorporate a check as part of our GitLab and GitHub doc releases.
I keep forgetting about the UX design guide (we inherited this from an intern and added it to the API docs). I did a pitiful job of making sure the links worked.
We can revisit the link style in the future. I'm really interested in moving all these docs to GitLab.

[bcantoni]

@d45 good point - let me document here for my own recall as well:

1. Install python version of https://linkchecker.github.io/linkchecker/: pip install linkchecker
2. Run local GH Pages equivalent of docs: bundle install followed by bundle exec jekyll serve
3. Run linkchecker against it: linkchecker --ignore-url googleapis --ignore-url localhost --check-extern http://127.0.0.1:4000/extensions-api/

The ignore for "googleapis" is because those were causing false alarms; the links work from a browser but not from the tool. The ignore for "localhost" is to avoid interpreting our "how to run locally" instructions as a real link.

You could also run the linkchecker against the live docs on https://tableau.github.io/extensions-api/, but the tool runs so fast you can sometimes run into rate limits. Running against local has the benefit also of confirming as you fix things.

I agree it would be great if a PR against the docs could generate both a hosted preview build and a link check against it.

[d45]

@bcantoni - awesome! I'm sure we could incorporate this check with our GitLab docs (Embedding API v3, Hyper API, etc.).
Running it manually for GitHub Help is another option before each PR. Thanks!

[seanmakesgames]

looks good to me!

[d45]

@bcantoni Looks good. Got ahead and merge with dev if you aren't waiting on other changes. I need to update ux_fonts.md to add a reference to using Workbook filtering (Brian Carver pointed this out). I'm adding a new topic for that.