-
Notifications
You must be signed in to change notification settings - Fork 1.2k
[apps] added documentation and screenshots for reusable modules #33056
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
Merged
+77
−0
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
69 changes: 69 additions & 0 deletions
69
content/en/actions/app_builder/components/reusable_modules.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| --- | ||
| title: Reusable Modules | ||
| description: Save and reuse groups of components and queries across multiple App Builder applications as modular templates. | ||
| disable_toc: false | ||
| further_reading: | ||
| - link: "/service_management/app_builder/components/" | ||
| tag: "Documentation" | ||
| text: "Components" | ||
| - link: "/service_management/app_builder/build/" | ||
| tag: "Documentation" | ||
| text: "Build Apps" | ||
| - link: "/service_management/app_builder/queries/" | ||
| tag: "Documentation" | ||
| text: "Queries" | ||
| --- | ||
|
|
||
| Use the _Reusable Modules_ feature to save groups of components and queries as templates for reuse across your App Builder applications. Modules automatically include all dependencies to ensure your components function correctly. | ||
Chau-DDOG marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| <div class="alert alert-info">Default modules are read-only. To modify a default module, duplicate it first.</div> | ||
|
|
||
| ## Create a reusable module | ||
|
|
||
| There are three ways to create a reusable module: | ||
|
|
||
| ### From the components panel | ||
| 1. While editing an app, click the expand icon (<i class="icon-expand-to-left-wui" style="position:relative; top:4px;"></i>) to open the components panel. | ||
| 2. Click a component to select it. | ||
| 3. In the components panel, click the menu icon (<i class="icon-config-1" style="position:relative; top:4px;"></i>). | ||
| 4. Click Create Module ({{< img src="service_management/app_builder/reusable-module-icon.svg" inline="true">}}). | ||
| 5. [Configure your module][3]. | ||
|
|
||
| ### From a component's instance name tab | ||
| 1. While editing an app, select a component on the app canvas. | ||
| 2. Click the Create Module icon ({{< img src="service_management/app_builder/reusable-module-icon.svg" inline="true">}}) in the component instance name tab. | ||
| 3. [Configure your module][3]. | ||
|
|
||
| ### From selected components | ||
| 1. While editing an app, hold down the Shift key and click multiple components to select them. | ||
| 2. In the side panel that appears on the right, click Create Module ({{< img src="service_management/app_builder/reusable-module-icon.svg" inline="true">}}). | ||
|
|
||
| ## Configure a module | ||
|
|
||
| When creating your module, the module editor allows you to preview the components and queries, add a name and description, and review dependencies before saving. | ||
|
|
||
| {{< img src="service_management/app_builder/app-builder-reusable-module-preview.png" alt="Module editor showing preview of components and queries with name and description fields" style="width:100%;">}} | ||
OliviaShoup marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| 1. Enter a name and description. | ||
| 2. Review the components and queries that are automatically included. The system includes all nested query dependencies. | ||
| 3. Click Save Module. | ||
|
|
||
| ## Add a reusable module to an app | ||
| 1. While editing an app, click the Add Component icon (<i class="icon-component-wui" style="position:relative; top:4px;"></i>). | ||
| 2. In the Modules section, click a module or drag it onto the app canvas. | ||
|
|
||
|
|
||
| ## Delete a module | ||
| 1. While editing an app, click the Add Component icon (<i class="icon-component-wui" style="position:relative; top:4px;"></i>). | ||
| 2. In the Modules section, click the edit icon ({{< img src="icons/pencil.png" inline="true" style="width:14px;">}}) for the module you want to delete. | ||
| 3. In the module editor, click Delete Module. | ||
|
|
||
| ## Further reading | ||
|
|
||
| {{< partial name="whats-next/whats-next.html" >}} | ||
|
|
||
| <br>Do you have questions or feedback? Join the **#app-builder** channel on the [Datadog Community Slack][2]. | ||
|
|
||
| [1]: https://app.datadoghq.com/app-builder/apps/list | ||
| [2]: https://chat.datadoghq.com/ | ||
OliviaShoup marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| [3]: /actions/app_builder/components/reusable_modules/#configure-a-module | ||
Binary file added
BIN
+50.2 KB
.../service_management/app_builder/app-builder-reusable-module-component-panel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+1.2 MB
...c/images/service_management/app_builder/app-builder-reusable-module-preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions
3
static/images/service_management/app_builder/reusable-module-icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.