feat: Promote Community Apps submission entrypoint#481
Merged
Conversation
- Purpose: document the Community Applications repository submission process in the docs site. - Before: the Community Applications page only had a brief contribution section and pointed maintainers to the old Asana submission form. - Problem: app maintainers lacked in-repo guidance for repository structure, XML metadata, supported fields, and the current submission portal. - Change: add a dedicated submission docs section with overview, repository XML, ca_profile.xml, field reference, and builder guide pages. - Implementation: link the existing Community Applications page to the new section, move the submission URL to ca.unraid.net/submit, update translated snapshot links, and adjust sidebar ordering.
Contributor
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (76)
Disabled knowledge base sources:
📝 WalkthroughWalkthroughThis PR consolidates Unraid's Community Applications documentation by establishing a unified ChangesCommunity Applications Documentation Hub Consolidation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
ESLint skipped: no ESLint configuration detected in root package.json. To enable, add Comment |
elibosley
changed the title
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
unraid-docs | bda1884 | Commit Preview URL Branch Preview URL |
May 14 2026, 04:06 PM |
- Purpose: make ca.unraid.net/submit the single source of truth for Community Applications submission guidance. - Before: the PR duplicated portal-owned repository XML, ca_profile.xml, field reference, and builder guidance in this docs site. - Problem: duplicating submission details makes it easier for the docs site and portal to drift, and gives users more than one place to check. - Change: remove the local submission guide pages and simplify the Community Applications contribution section to point at the submission portal and help page. - Implementation: delete the local submission docs category, restore the container-management sidebar position, and keep translated snapshot links pointed at ca.unraid.net/submit from the previous commit.
elibosley
changed the title
- Purpose: make the Community Apps submission portal link easier to find on the docs page. - Before: the portal appeared only as inline text and a numbered-list link. - Problem: maintainers could miss the canonical submission destination while scanning the page. - Change: add a large centered primary CTA button linking to ca.unraid.net/submit. - Implementation: use Docusaurus button classes with modest inline sizing inside the existing Community Applications MDX page.
- Purpose: promote Community Applications to a top-level docs page above Unraid Connect. - Before: the page lived under Run Docker containers, so it was harder to find and all internal docs linked to the nested path. - Problem: Community Applications is a broad entry point for plugins and apps, not only Docker container guidance. - Change: move the Community Applications MDX file and localized counterparts to the docs root with sidebar position 1.5. - Implementation: update partial imports, internal links, localized link references, and redirects from the old nested route; fix the install section to direct users to the Apps tab.
elibosley
changed the title
- Purpose: route docs home Community Applications links through the new root docs page. - Before: the docs home resource links bypassed the docs entrypoint and opened the external app catalog directly. - Problem: after promoting Community Applications to a root docs page, discovery links should consistently land on the new guidance page. - Change: update source and translated docs home resource links to /community-applications/. - Implementation: keep app-specific catalog links elsewhere unchanged and leave /go/applications/ redirected to the new docs page.
elibosley
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Promotes Community Applications to a root-level docs page positioned above Unraid Connect, with redirects from the old nested route and the existing
/go/applications/and manual applications redirects updated to the new/community-applications/path.Updates docs home Community Applications resource links to use
/community-applications/so users land on the new docs entrypoint before jumping to external app catalog workflows.Updates the Community Applications contribution section to make
https://ca.unraid.net/submitthe canonical submission entrypoint, with a prominent centered CTA button. The detailed submission guidance remains on the CA portal as the single source of truth.Fixes the Community Applications install instructions to tell users to navigate to the Apps tab instead of the Plugins tab.
Impact
Community Applications is easier to find in the primary docs navigation, existing internal and Go links now point to the new root page, and old nested URLs continue to redirect.
Validation
pnpm exec remark docs/community-applications.mdx docs/API/index.mdx docs/API/partials/get-started-pre72.mdx docs/unraid-connect/overview-and-setup.mdx docs/unraid-os/getting-started/explore-the-user-interface/tour-the-web-gui.mdx docs/unraid-os/getting-started/set-up-unraid/customize-unraid-settings.mdx docs/unraid-os/getting-started/what-is-unraid.mdx docs/unraid-os/system-administration/advanced-tools/command-line-interface.mdx docs/unraid-os/system-administration/secure-your-server/security-fundamentals.mdx docs/unraid-os/system-administration/secure-your-server/tailscale.mdx docs/unraid-os/using-unraid-to/customize-your-experience/plugins.mdx docs/unraid-os/using-unraid-to/run-docker-containers/managing-and-customizing-containers.mdx docs/unraid-os/using-unraid-to/run-docker-containers/overview.mdx --quiet --frailpnpm exec remark docs/docs-home.mdx docs/community-applications.mdx --quiet --frailnode scripts/check-case-sensitivity.jspnpm exec prettier --check docusaurus.config.tsrg -n "community-applications\.mdx|unraid-os/using-unraid-to/run-docker-containers/community-applications|l\.onglet|form\.asana" docs i18n docusaurus.config.ts static || trueFull build intentionally not run per repo guidance.
Summary by CodeRabbit
Release Notes