Skip to content
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

Create a 'getting started' guide for developers #88

Closed
samccann opened this issue Sep 2, 2020 · 8 comments
Closed

Create a 'getting started' guide for developers #88

samccann opened this issue Sep 2, 2020 · 8 comments
Assignees
Labels
documentation Improvements or additions to documentation MUNI tech writers

Comments

@samccann
Copy link
Contributor

samccann commented Sep 2, 2020

SUMMARY

This came up as a possible ansibleFest topic, so thought it would be worth having a specific getting started guide for developers so they can quickly learn how to:

  • get ansible from source and set up your basic development environment
  • Open a PR for a bugfix or new option to a module
  • how to find the module source code in the collections world
  • PR requirements like changelogs, unit tests, etc
  • keeping your PR current for newer versions of the upstream repo

(git remote add ; git fetch ; git merge --ff-only to devel ; git checkout feature-branch ; git rebase devel )

ISSUE TYPE
  • Documentation Report
COMPONENT NAME

docs.ansible.com

ANSIBLE VERSION

CONFIGURATION

OS / ENVIRONMENT
ADDITIONAL INFORMATION
@samccann
Copy link
Contributor Author

samccann commented Sep 2, 2020

https://github.com/greg-hellings/ansible_collection_demo - has some info that might be helpful for starting a new collection.

@s-hertel
Copy link
Contributor

@samccann Can you move this to the new repo?

@samccann
Copy link
Contributor Author

yes I plan on going through all the docs issues after June 10th to move them all over. That' the proposed 'official' date when the split happens. I can try to do it sooner, but I'm out from Friday until that date so didn't want to rush it all.

@s-hertel
Copy link
Contributor

Thanks, this was just in our backlog queue.

@samccann samccann transferred this issue from ansible/ansible Jul 11, 2023
@samccann samccann added the documentation Improvements or additions to documentation label Aug 1, 2023
@oraNod
Copy link
Contributor

oraNod commented Mar 20, 2024

Estimated effort: L (MUNI tech writers)

@xszabo3
Copy link
Contributor

xszabo3 commented Apr 7, 2024

@oraNod Hi! Can I work on this issue?

@oraNod
Copy link
Contributor

oraNod commented Apr 8, 2024

@xszabo3 Welcome! Yes, please go ahead. I've assigned this issue to you. Feel free to ask any questions here or in the docs channel on Matrix.

@samccann
Copy link
Contributor Author

Thanks to @xszabo3 for realizing this issue was actually already solved by https://docs.ansible.com/ansible/latest/community/create_pr_quick_start.html. I'll create a new issue for what was discussed in the docs matrix channel and assign the new one to you (as it is of similar scope/size).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation MUNI tech writers
Projects
Status: Done
Development

No branches or pull requests

4 participants