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

Community Modules documentation #1812

Open
5 tasks
janmedrek opened this issue Aug 28, 2024 · 0 comments
Open
5 tasks

Community Modules documentation #1812

janmedrek opened this issue Aug 28, 2024 · 0 comments
Assignees

Comments

@janmedrek
Copy link
Contributor

janmedrek commented Aug 28, 2024

Description

Documentation should be provided that describes how to create a Community Module. It should include creating a ModuleTemplate, good practices and recommendations regarding Status handling.

Ideally, it should start with a landing page and lead to further reading regarding specific aspects/sections of building a module.

Reasons

There is little to no documentation available to the OS users who would like to contribute their modules. It should be very easy to jump into the Module Ecosystem.

Acceptance Criteria

  • Community Modules documentation includes
    • What is a Community Module
    • How to create a Community Module (including ModuleTemplate build)
    • What module metadata is required and where to put it
    • Recommendations on what Statuses should be used in which situations

Attachments

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

No branches or pull requests

1 participant