Contribute

The NAPS DA Project welcomes contributions! Please contribute and help in expanding the breadth and depth of content we showcase to customers!

Table of Contents

• Content Template
• Pull Requests
  • Create a fork!
  • Stay in Sync
    • Configuring Your Remotes
    • Rebasing Your Branch
    • Updating your Pull Request
  • Create a pull requests

Content Template

{::options parse_block_html="true" /}
<div class="collapse">*
<details><summary markdown="span">**TITLE**</summary>
<br>

  <span style="color:#0000CD">**Overview:**</span>

  The multi-cloud demo (workflow) consists of:
  1. Provision VMs in (1) Azure and (2) AWS
  2. In AWS configure an Apache server, in Azure an IIS server.
  3. Post in slack channel that multi-cloud workflow has finished.
  4. If any of the process fails (for example if the cloud availability is full) tear down in that cloud.

  <span style="color:#228B22">**Takeaways:**</span>

  1. Vendor-agnostic infrastructure-as-code
  2. Ansible used to provision **`and`** post-provision across clouds
  3. All infra is exposed as yml variable so it's human-friendly to use while still being flexible and powerful
  4. Can leverage the input and ouput of Tower. E.g. we kick it off from hosted services catalog to trigger and post to slack after it's finished but could also be kicked off from any CMDB and integrated with other Chatops.

  <span style="color:#a50000">Video Demonstration:</span>

  [![DEMO](http://img.youtube.com/vi/YOUTUBE_VIDEO_ID.jpg)](http://www.youtube.com/watch?v=YOUTUBE_VIDEO_ID "**TITLE**"){:target="_blank"}

</details>
</div>
{::options parse_block_html="false" /}

1. Edit:
   • Line 3 - TITLE
   • Line 8+ - Define Overview
   • Line 14+ - Define Takeaways*
   • Line 23 - Replace YOUTUBE_VIDEO_ID x 2 with youtube video id
2. Add your_title markdown file to appropriate technology folder {ansible, openshift, acm}
3. Include your_title markdown to {ansible | openshift | acm} markdown starting line 9
   • See the ansible markdown file in the ansible folder

Pull Requests

We take pull requests! What is a pull request?

Pull requests let you tell others about changes you’ve pushed to a branch in a repository on GitHub. Once a pull request is opened, you can discuss and review the potential changes with collaborators and add follow-up commits before your changes are merged into the base branch

More info on PRs: https://help.github.com/en/articles/about-pull-requests

Create a fork!

Create a fork on your own Github project (or your personal space)

Github Documentation on Forking a repo

Stay in Sync

It is important to know how to keep your fork in sync with the upstream napsda project.

Configuring Your Remotes

Configure napsda/napsda.github.io as your upstream so you can stay in sync

git remote add upstream https://github.com/napsda/napsda.github.io.git

Rebasing Your Branch

Rebase the branch on your fork

git pull --rebase upstream devel

Check your status

git status

Updating your Pull Request

git push --force

More info on docs.ansible.com: Rebasing a Pull Request

Create a pull request

Make sure you are not behind (in sync) and then submit a PR to the napsda. Read the Pull Request Documentation on Github.com

• WHY? Why did you make the change?
• WHO? Who is this for? If this is something for a limited audience it might not make sense for all users.
• CONTENT? What content are you providing?

Being more descriptive is better and will making merging into upstream easier and quicker! Communication is key! Just b/c the PR doesn’t get accepted right away doesn’t mean it is not a good idea. Thank you for contributing!