Skip to content

Doc updates including new page for troubleshooting #701

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

Jump to bottom
Merged
bcantoni merged 1 commit into from
Oct 1, 2020
Merged

Doc updates including new page for troubleshooting #701

bcantoni merged 1 commit into from
Oct 1, 2020

Conversation

@bcantoni
Copy link
Contributor

@bcantoni bcantoni commented Sep 29, 2020 •
edited
Loading

This PR includes a batch of doc updates including:

  • add new troubleshooting page showing how to capture REST API traffic
  • rewrite sign in / sign out page to be more clear, in particular server vs online, and to - mention switch_site
  • dev-guide, index, samples, versions: some general edits and improvements
  • api-ref: added auth.switch_site (from Enable switch site functionality #655)

Nothing in here is tied to any code changes, so it can be merged into gh-pages when ready. I'll squash all the commits before merging.

@bcantoni bcantoni changed the title Doc updates including new page for troubleshooting WIP: Doc updates including new page for troubleshooting Sep 29, 2020
@bcantoni
Copy link
Contributor Author

bcantoni commented Sep 29, 2020

These pages are reviewable - one more page coming.

@bcantoni bcantoni changed the title WIP: Doc updates including new page for troubleshooting Doc updates including new page for troubleshooting Sep 29, 2020
shinchris
shinchris suggested changes Oct 1, 2020
View reviewed changes
Copy link
Contributor

@shinchris shinchris left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lots of really useful additions!

shinchris
shinchris approved these changes Oct 1, 2020
View reviewed changes
Copy link
Contributor

@shinchris shinchris left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@bcantoni
Add troubleshooting guide, rewrite sign in page, general improvements
243fc99 
- Add troubleshooting guide for capturing REST API traffic
- Add docs for site_switch() added in #655
- Rewrite sign in/out page to be more clear
- Add docs for PersonalAccessTokenAuth added in #465
- Some general edits and wordsmithing
@bcantoni
Copy link
Contributor Author

bcantoni commented Oct 1, 2020

Thanks Chris for the feedback - I squashed and rebased so it can merge as one commit. (And I did a trim all trailing white space on api-ref.md to clean that up.)

@bcantoni bcantoni merged commit 6f1b06e into gh-pages Oct 1, 2020
@bcantoni bcantoni deleted the doc-2020-09 branch October 1, 2020 21:54
@bcantoni bcantoni mentioned this pull request Nov 2, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@shinchris shinchris shinchris approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@bcantoni @shinchris