---
# System prepended metadata

title: Ansible SDK documentation
tags: [Documentation]

---

###### tags: `Documentation`

# Ansible SDK documentation

## SDK doc content

https://issues.redhat.com/browse/AAP-5749

Remaining work:

- Close out diagrams.
-- Does the local executor diagram need to show Runner?
-- Do we want to include the analytics and insights diagram as future capabilities? Or do we want to exclude this diagram for now?
-- Is the description for the Mesh diagram accurate?
- Update install scenarios to include RHEL.

## SDK docs build

Jira issue: TBD

Separate the content set into API reference vs conceptual/procedural content with different conf.py files.

Suggested approach: Abandon RTD and use an action that rsyncs to httpd running on aws.

- Results in docs.ansible.com/ansible-sdk
- Avoids Sphinx constraints that kill velocity / better solution for the amount of churn
- Gives a better option for hosting content downstream

https://people.redhat.com/dnaro/ansible-sdk/api/index.html
https://people.redhat.com/dnaro/ansible-sdk/intro.html

## RST to ADOC conversion

Jira issue: TBD

Do we want to create an RST to ADOC job for Ansible-SDK docs?

Reasons for doing this:

- Asciidoc content is available in ansible/aap-docs
- Creates a straight path for community contributions from RH teams like support and field enablement

Keep the RST source clean and simple and conversion is reliable.
Helps avoid an approach that is too Sphinx-specific, which adds a barrier to entry for contributors.

