Skip to content
This repository has been archived by the owner on Jun 10, 2024. It is now read-only.

Network First Gamification Exercise - Earn Ansible Swag! #311

Closed
gundalow opened this issue May 17, 2018 · 3 comments
Closed

Network First Gamification Exercise - Earn Ansible Swag! #311

gundalow opened this issue May 17, 2018 · 3 comments
Labels
docs related to documentation

Comments

@gundalow
Copy link
Contributor

gundalow commented May 17, 2018

WE WANT PULL REQUESTS FOR ANSIBLE NETWORKING DOCUMENTATION

5 pull requests == 1 t-shirt shipped to your house

t-shirt

  • keep pull requests simple
  • keep pull requests small
  • keep pull requests succinct

Documentation pull requests can be a 1-task example... in fact, we encourage very simple 1-task examples!

RULES

EXAMPLE PULL REQUEST

ansible/ansible#40021

All I did for the ios_l3_interface module was add this example to the documentation after testing it on my own Cisco switch

- name: Set interface Vlan1 (SVI) IPv4 address
  ios_l3_interface:
    name: Vlan1
    ipv4: 192.168.0.5/24

Validation

To make sure you're adding a valid new example for the platform you've selected, you must use your new example in a playbook and your pull request must include:

  • the output of the playbook
  • the output of the relevant show command on the network device so we know the playbook was actually executed

For the example above, here's a playbook:

➜  ansible-napalm-samples git:(master) ✗ ansible-playbook test.yml

PLAY [arista] ********************************************************************************************************************************************************************

TASK [Set interface Vlan1 (SVI) IPv4 address] ************************************************************************************************************************************
changed: [eos]

PLAY RECAP ***********************************************************************************************************************************************************************
eos                        : ok=1    changed=1    unreachable=0    failed=0

Here's the proof that it ran properly:

eos#sh run int vlan1
interface Vlan1
  ip address 192.168.0.5/24

HOW? HOW DO I DO IT?

  1. Create a fork!
    Create a fork on your own Github personal space
    GitHub Documentation on Forking a repo

Ensure your fork is up to date https://docs.ansible.com/ansible/latest/dev_guide/developing_rebasing.html

  1. Configuring Your Remotes
    Configure github.com/ansible/ansible as your upstream so you can stay in sync
    git remote add upstream https://github.com/ansible/ansible.git

  2. Rebasing Your Branch
    git pull --rebase upstream master

CREATE THE PULL REQUEST

https://help.github.com/articles/creating-a-pull-request/

Please comment here if you have questions or we need more documentation to make this process easy!

@IHackPy
Copy link

IHackPy commented May 18, 2018

I'm new to ansible .... I'm confused from where to start?
Should I learn hardcore concepts of ansible for contributing too this?

@LindsayHill
Copy link

@himanshuawasthi95 if you're new to Ansible, then I would suggest just start with learning that first. Come back to this a little later.

You don't need to know a lot about detailed Ansible to contribute to this, but it will be a distraction from learning Ansible up front. Cover that first.

benpiper added a commit to benpiper/ansible that referenced this issue May 25, 2018
+label: docsite_pr
Issue ansible/community#311

SUMMARY
Add example for setting OSPF RID

ISSUE TYPE
Docs Pull Request
COMPONENT NAME
nclu

ANSIBLE VERSION
ansible 2.5.2

ADDITIONAL INFORMATION
Issue ansible#311
hemskgren added a commit to hemskgren/ansible that referenced this issue Jun 7, 2018
jacum pushed a commit to jacum/ansible that referenced this issue Jun 26, 2018
* add example using peer keepalive vrf and delay restore

<!--- Your description here -->
add example using peer keepalive vrf and delay restore
+label: docsite_pr
+label: issue ansible/community#311

* Update nxos_vpc.py

update task name to include "existing"
felixfontein pushed a commit to felixfontein/ansible that referenced this issue Jul 20, 2018
* add example using aggregate
+label: docsite_pr
+label: issue ansible/community#311
* Update nxos_logging.py
samccann pushed a commit to samccann/ansible that referenced this issue Jul 24, 2018
* add example using peer keepalive vrf and delay restore

<!--- Your description here -->
add example using peer keepalive vrf and delay restore
+label: docsite_pr
+label: issue ansible/community#311

* Update nxos_vpc.py

update task name to include "existing"

(cherry picked from commit d6fb00e)
mattclay pushed a commit to ansible/ansible that referenced this issue Jul 27, 2018
* add example using peer keepalive vrf and delay restore

<!--- Your description here -->
add example using peer keepalive vrf and delay restore
+label: docsite_pr
+label: issue ansible/community#311

* Update nxos_vpc.py

update task name to include "existing"

(cherry picked from commit d6fb00e)
ansibot pushed a commit to ansible/ansible that referenced this issue Aug 1, 2018
@gundalow gundalow removed the network label Aug 2, 2018
@acozine acozine added the docs related to documentation label Aug 17, 2018
acozine pushed a commit to hemskgren/ansible that referenced this issue Sep 18, 2018
acozine pushed a commit to acozine/ansible that referenced this issue Sep 18, 2018
* update asa_config with bgp doc example

+label: docsite_pr
Issue ansible/community#311

* fix spelling
acozine pushed a commit to hemskgren/ansible that referenced this issue Sep 18, 2018
@gundalow
Copy link
Contributor Author

Thanks to everyone that participated, this is now closed.

devyanikota pushed a commit to devyanikota/ansible that referenced this issue Sep 18, 2018
* asa_config add doc l3 interface

+label: docsite_pr
Issue ansible/community#311

* fix interface idempotent

* newline, names, and debug:var
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
docs related to documentation
Projects
None yet
Development

No branches or pull requests

4 participants