8000 GitHub - scottharwell/aap-docs: Asciidoc technical content for Ansible Automation Platform
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

scottharwell/aap-docs

 
 

Repository files navigation

Red Hat Ansible Automation Platform documentation

Welcome to the source for Ansible Automation Platform on Clouds technical content.

Viewing draft documentation

Draft documentation is available at:

Note

Draft documentation does not include images. You can view images directly in the repository or clone the repository and open the HTML preview in your browser.

Cloning and previewing

For local previews that include images you can do the following:

$ git clone -b aap-clouds-latest git@github.com:ansible/aap-docs.git
$ asciidoctor aap-docs/titles/aap-on-azure/aap-on-azure.asciidoc
$ firefox aap-docs/titles/aap-on-azure/aap-on-azure.html

Generating HTML previews

Merging a commit to the repository automatically generates HTML previews. If necessary, you can build HTML previews locally as follows:

$ asciidoctor titles/aap-on-azure/aap-on-azure.asciidoc
$ firefox titles/aap-on-azure/aap-on-azure.html

Undoing local HTML previews

Generating HTML previews locally can result in merge conflicts with .html files. This happens when .html files are automatically generated and added to the repository after merge. The merge adds a new commit with changes to an *.html file that conflict changes in your locally built preview.

Before you commit changes and send a PR, you should checkout the latest preview. Doing this overrides your local HTML with the generated one. However, when your commit is merged, the preview will generate HTML with your changes.

# Make sure your remotes are up to date.
$ git fetch
# For example, check out the Azure html to reset changes from a local build.
$ git checkout titles/aap-on-azure/aap-on-azure.html

AAP on Clouds production docs

AAP on Clouds documentation is available at:

AAP documentation

Additional documentation source for AAP is available at:

About

Asciidoc technical content for Ansible Automation Platform

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 90.2%
  • 2CA9
  • Shell 9.8%
0