docs: add getting-started tutorial for API integration#532
Open
docs: add getting-started tutorial for API integration#532
Conversation
fix: pin markdownlnt version to 0.9.35 fix the issue caused by Markdown linter updates canonical/sphinx-docs-starter-pack#509 fix: do not fail if no markdown files found
tang-mm
force-pushed
the
TO-268-doc-first-tutorial
branch
from
26cc063 to
830172c
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds the first tutorial to TO documentation to onboard users with the API integration workflow. It builds a sample Python script to interact with the staging API:
Resolved issues
TO-268
Documentation
New tutorial added to
docs/tutorial/following Diataxis framework. Updated main documentation homepage to link to tutorial section.Web service API changes
N/A
Tests