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

Add/improve documentation #17

Closed
lkubb opened this issue Aug 1, 2024 · 0 comments · Fixed by #31
Closed

Add/improve documentation #17

lkubb opened this issue Aug 1, 2024 · 0 comments · Fixed by #31

Comments

@lkubb
Copy link
Member

lkubb commented Aug 1, 2024

The process of creating and maintaining Salt extensions (within or outside of this organization) is currently under-documented. I have read several accounts that describe difficulty and confusion around it - the lack of community maintainers might be a symptom.

Since this Copier template could serve as the pivot of most Salt extension development, this repository would be a natural choice for general documentation/guides regarding

a) creating
b) writing + testing
c) documenting
d) publishing
e) maintaining

Salt extensions (at least for a start, we could outsource it later once it's more established).

I'd like to include a proper, Sphinx-built documentation regarding these topics.

Related: #15

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant