Skip to content

Commit 23496fd

Browse files
committed
docs: update Community Applications submission guidelines and clarify requirements
1 parent dd4e68e commit 23496fd

1 file changed

Lines changed: 64 additions & 13 deletions

File tree

‎docs/distribution/community-applications.md‎

Lines changed: 64 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -116,43 +116,94 @@ https://raw.githubusercontent.com/username/repo/main/images/icon.png
116116
### 1. Prepare Your Plugin
117117

118118
Ensure your plugin:
119+
119120
- Works correctly on supported Unraid versions
120121
- Has a stable PLG file URL
121122
- Includes proper versioning
122123

123124
### 2. Create Support Thread
124125

125126
Create a support thread on the [Unraid Forums](https://forums.unraid.net/forum/61-plugin-support/):
127+
126128
- Choose an appropriate subforum
127129
- Include installation instructions
128130
- Document features and usage
129131
- Monitor for user feedback
130132

131133
### 3. Create CA Template
132134

133-
Host your template XML file in your repository or submit it to the CA templates repository.
135+
Host your template XML file and icon assets in your own public GitHub repository. This is the repository you will submit in the Asana form.
136+
137+
- Use your own repo as the primary submission source.
138+
- Include one or more valid Unraid Docker or Plugin XML templates.
139+
- Include a `ca_profile.xml` file with a non-empty `<Profile>` section for author/support information.
140+
- Add an OSL-approved open source license for repository contents (templates, metadata, and docs).
141+
- Ensure the repository is public, active, and not archived or disabled.
142+
143+
### 4. Submit to CA via Asana form
144+
145+
The current CA intake process uses the Asana submission form. This is the step that actually sends your plugin and template details to the CA maintainers.
146+
147+
- [Community Applications Asana submission form](https://form.asana.com/?k=qtIUrf5ydiXvXzPI57BiJw&d=714739274360802)
148+
149+
![CA Asana submission form](../../assets/images/screenshots/ca-asana-submission-form.png)
150+
151+
The Asana form typically asks for:
152+
153+
- Maintainer / author contact information
154+
- GitHub repository URL containing your XML template
155+
- Preferred repository name for CA listing
156+
- Confirmation of GitHub 2FA and repository visibility
157+
- Support thread URL and project XML requirements
158+
- Agreement to Community Applications policies
159+
- Optional comments or additional notes
134160

135-
### 4. Submit to CA
161+
Submit the form after your own repository is ready and your support thread exists.
136162

137-
**Option A: CA Templates Repository (Recommended)**
163+
The repository you submit should meet these requirements:
138164

139-
<img src="../../assets/images/logos/GitHub%20Logos/GitHub_Invertocat_White.svg" alt="GitHub" height="32" style="vertical-align: middle; margin-right: 0.5rem;"> Fork and submit a pull request:
165+
- Public and active GitHub repo (not private, archived, or disabled)
166+
- Valid Unraid Docker or Plugin XML templates
167+
- `ca_profile.xml` with a non-empty `<Profile>` section
168+
- OSL-approved open source license for repository contents
169+
- Icon assets and metadata hosted in the repository or via stable URLs
140170

141-
1. Fork the [CA templates repository](https://github.com/Squidly271/plugin-repository)
142-
2. Add your template XML to the appropriate folder
143-
3. Submit a pull request
144-
4. Wait for review and approval
171+
Helpful CA resources include:
145172

146-
**Option B: Self-Hosted Template**
173+
- Submission Help
174+
- Repository XML Format
175+
- Repository Information XML
176+
- XML Field Reference
177+
- Builder Guide
178+
- Starter Repository
179+
- Forum Support Thread
180+
- Contact Support
147181

148-
Contact the CA maintainer via the forums with:
149-
- Your template XML
150-
- Link to your plugin
151-
- Link to your support thread
182+
This form is the current official submission path. The `ca.unraid.net/submit` preview is a separate repo-based workflow and should be considered secondary until it is fully live.
183+
184+
#### New `ca.unraid.net/submit` preview
185+
186+
A new repository submission UI is also available, but it is not yet officially live and only partially works. Use the Asana form for current submissions.
187+
188+
![CA repository submission UI](../../assets/images/screenshots/ca-repository-submit.png)
189+
190+
The preview interface shows a repository-based workflow with requirements such as:
191+
192+
- Public GitHub repository with valid Unraid Docker or Plugin XML templates
193+
- A `ca_profile.xml` file with author/support information
194+
- An OSL-approved open source license for repository contents
195+
- A GitHub URL entry and review step before submit
196+
197+
For reference, CA also documents the overall app process at:
198+
199+
- [Unraid docs: Community Applications](https://docs.unraid.net/unraid-os/using-unraid-to/run-docker-containers/community-applications/)
200+
201+
> Note: The `https://ca.unraid.net/submit` page is still in preview and should not be relied on for production submissions.
152202
153203
### 5. Await Approval
154204

155205
The CA maintainer will review your submission:
206+
156207
- Verify plugin works correctly
157208
- Check template accuracy
158209
- Ensure support thread exists

0 commit comments

Comments
 (0)