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

Improve release process documentation #221

Open
1 task done
felixfontein opened this issue Apr 26, 2023 · 4 comments
Open
1 task done

Improve release process documentation #221

felixfontein opened this issue Apr 26, 2023 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@felixfontein
Copy link
Contributor

felixfontein commented Apr 26, 2023

Create a folder docs/, and create documents in there describing all aspects of the release process.

@gotmax23
Copy link
Contributor

#224 is a start. Feedback welcome!

@gotmax23
Copy link
Contributor

gotmax23 commented May 2, 2023

Here is my idea for a documentation layout:

  • docs/policies.md - breakdown of Ansible Community Steering Committee Policies that apply to this repository add release documentation scaffolding #224 is a start, but the Removal From Ansible policy still needs to be added.
  • docs/adding.md - short explanation of how to add a collection to the ansible. This can borrow text from the existing README.
  • docs/release-process.md - step by step breakdown of the ansible release process. I know the basics of the release process, but I may need to consult with @anweshadas for specifics if I write this. (Add initial release-process.md #227)
  • docs/new-ansible.md - explanation about creating a new ansible release. This should cover creating the {MAJOR VERSION} directory, generating the ansible-{MAJOR VERSION}.build file, and creating frozen releases. This would serve as an appendix to docs/release-process.md
  • docs/structure.md - breakdown of the repository structure. This can also borrow text from the existing README.

What do folks think?

@Andersson007
Copy link
Contributor

SGTM

@gotmax23
Copy link
Contributor

gotmax23 commented May 6, 2023

I took a stab at documenting the release process (docs/release-process.md) in #227.

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
Projects
None yet
Development

No branches or pull requests

3 participants