PROD-8165 add extension development/deployment documentation#538
Open
ivbond wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new “Extensions” documentation section to the ThingsBoard docs site, including end-to-end guidance for building, deploying, and operating ThingsBoard extensions, and exposes that section in the Reference navigation.
Changes:
- Introduces new Extensions reference pages (overview, quickstart, dev workflow, CLI deploy reference, REST deployment API) for CE/PE/Cloud variants via shared
_includes. - Adds Extensions links to the “APIs & SDKs” reference landing include and to the generated sidebar navigation.
- Adds new extension-related schema diagrams (light/dark variants) used by the docs.
Reviewed changes
Copilot reviewed 27 out of 41 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/content/docs/docs/reference/extensions/quickstart.mdx | CE wrapper page for Extensions quickstart include |
| src/content/docs/docs/reference/extensions/overview.mdx | CE wrapper page for Extensions overview include |
| src/content/docs/docs/reference/extensions/development-workflow.mdx | CE wrapper page for development workflow include |
| src/content/docs/docs/reference/extensions/deployment-api.mdx | CE wrapper page for deployment API include |
| src/content/docs/docs/reference/extensions/cli-deployment.mdx | CE wrapper page for CLI deployment include |
| src/content/docs/docs/pe/reference/extensions/quickstart.mdx | PE wrapper page for Extensions quickstart include |
| src/content/docs/docs/pe/reference/extensions/overview.mdx | PE wrapper page for Extensions overview include |
| src/content/docs/docs/pe/reference/extensions/development-workflow.mdx | PE wrapper page for development workflow include |
| src/content/docs/docs/pe/reference/extensions/deployment-api.mdx | PE wrapper page for deployment API include |
| src/content/docs/docs/pe/reference/extensions/cli-deployment.mdx | PE wrapper page for CLI deployment include |
| src/content/docs/docs/paas/reference/extensions/quickstart.mdx | PaaS wrapper page for Extensions quickstart include |
| src/content/docs/docs/paas/reference/extensions/overview.mdx | PaaS wrapper page for Extensions overview include |
| src/content/docs/docs/paas/reference/extensions/development-workflow.mdx | PaaS wrapper page for development workflow include |
| src/content/docs/docs/paas/reference/extensions/deployment-api.mdx | PaaS wrapper page for deployment API include |
| src/content/docs/docs/paas/reference/extensions/cli-deployment.mdx | PaaS wrapper page for CLI deployment include |
| src/content/docs/docs/paas/eu/reference/extensions/quickstart.mdx | PaaS EU wrapper page for Extensions quickstart include |
| src/content/docs/docs/paas/eu/reference/extensions/overview.mdx | PaaS EU wrapper page for Extensions overview include |
| src/content/docs/docs/paas/eu/reference/extensions/development-workflow.mdx | PaaS EU wrapper page for development workflow include |
| src/content/docs/docs/paas/eu/reference/extensions/deployment-api.mdx | PaaS EU wrapper page for deployment API include |
| src/content/docs/docs/paas/eu/reference/extensions/cli-deployment.mdx | PaaS EU wrapper page for CLI deployment include |
| src/content/_includes/docs/reference/extensions/quickstart.mdx | Shared quickstart content (Java/Python tabs + CLI workflow) |
| src/content/_includes/docs/reference/extensions/overview.mdx | Shared overview content (architecture, routing/auth, lifecycle, run modes) |
| src/content/_includes/docs/reference/extensions/development-workflow.mdx | Shared “full loop” workflow guide content |
| src/content/_includes/docs/reference/extensions/deployment-api.mdx | Shared REST deployment API reference content |
| src/content/_includes/docs/reference/extensions/cli-deployment.mdx | Shared CLI deploy/reference content |
| src/content/_includes/docs/reference/apis-and-sdks.mdx | Adds an “Extensions” card/links to the reference landing include |
| src/assets/schemas/extension-mode-self-hosted.svg | New diagram asset used in Extensions overview (light) |
| src/assets/schemas/extension-mode-self-hosted-dark.svg | New diagram asset used in Extensions overview (dark) |
| src/assets/schemas/extension-lifecycle.svg | New diagram asset used in Extensions overview (light) |
| src/assets/schemas/extension-lifecycle-dark.svg | New diagram asset used in Extensions overview (dark) |
| astro.sidebar.ts | Adds “Extensions” group under APIs & SDKs sidebar section |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
Description
Type of change
src/content/docs/**)src/content/_includes/**)src/components/**,src/styles/**)src/pages/**,src/data/**)src/data/redirects.ts)releaseskill)Affected products
Related issues
Checklist
pnpm checkpasses (Astro / TypeScript)pnpm lint:eslintpassespnpm lint:slugcheckpasses (required if pages were added/renamed/moved across languages)pnpm lint:linkcheckpasses locally — required to merge; run it before requesting review (usepnpm lint:linkcheck:nobuildif you already ran a build)src/data/redirects.ts, andpnpm generate:redirectswas runsrc/data/versions.ts