Skip to content

Docs: Add basic localhost example to "Using the API" page #1212

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.

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

Merged
merged 2 commits into from
Sep 25, 2024

Conversation

pirate
Copy link
Contributor

@pirate pirate commented Sep 21, 2024

Fixes: #1211

This aims to improve the "getting started with the API" experience a bit:

  • add link to API source code
  • moves .old/api_deploy.py link to a Full Example section
  • add Basic Localhost Example section
    • clearly shows what imports are necessary
    • demonstrates setting up an inventory using @local for localhost
    • demonstrates setting up a Config with SUDO=True
    • includes links to API References docs on Inventory, Config, and facts
    • demonstrates how to run ops and collect facts afterwards

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
@pirate pirate changed the title Documentation: Add basic localhost example to API docs index Documentation: Add basic localhost example to "Using the API" page Sep 21, 2024
@pirate pirate changed the title Documentation: Add basic localhost example to "Using the API" page Docs: Add basic localhost example to "Using the API" page Sep 21, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
Copy link
Member

@Fizzadar Fizzadar left a comment

Choose a reason for hiding this comment

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

Nice, thanks for doing this @pirate!

@Fizzadar Fizzadar merged commit 838737e into pyinfra-dev:3.x Sep 25, 2024
22 checks passed
@pirate pirate deleted the patch-1 branch October 5, 2024 05:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Simple API example using localhost exits immediately and doesn't execute ops
2 participants