Skip to content

Commit c1edc0e

Browse files
Merge pull request #10537 from mendix/lint-docs
[Auto] Lint docs
2 parents df321e8 + 553c2a4 commit c1edc0e

27 files changed

Lines changed: 137 additions & 142 deletions

File tree

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/extensibility-api/web/migration-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,4 +78,4 @@ await studioPro.ui.extensionsMenu.add({
7878

7979
## Action Arguments
8080

81-
Action arguments are also possible in the new Menu API. Review the [Menus documentation](/apidocs-mxsdk/apidocs/web-extensibility-api-11/menu/) for a detailed explanation.
81+
Action arguments are also possible in the new Menu API. Review the [Menus documentation](/apidocs-mxsdk/apidocs/web-extensibility-api-11/menu/) for a detailed explanation.

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/extensibility-api/web/web-extensions-howtos/menu-api.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ If you are using Studio Pro 11.0–11.5 and your extension includes menus, your
2121
* This how-to uses the results of [Get Started with the Web Extensibility API](/apidocs-mxsdk/apidocs/web-extensibility-api-11/getting-started/). Make sure to complete that how-to before starting this one.
2222
* Review [how menus work](/apidocs-mxsdk/apidocs/web-extensibility-api-11/menu/) in the Web Extensibility API.
2323

24-
2524
## Creating a Simple Menu
2625

2726
The code below adds a simple menu to your extension. The code will:

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/extensibility-api/web/web-extensions-howtos/menu.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,4 +85,4 @@ export const component: IComponent = {
8585
await appExplorerApi.addContextMenu(documentContextMenuNoPayload, "Microflows$Microflow");
8686
}
8787
};
88-
```
88+
```

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/extensibility-api/web/web-extensions-howtos/message-passing-api.md

Lines changed: 45 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -137,56 +137,56 @@ In the broadcast pattern, one context sends a messages to all other contexts tha
137137

138138
1. Copy the following code into `src/main/index.ts`:
139139

140-
```typescript
141-
import { IComponent, getStudioProApi } from "@mendix/extensions-api";
142-
143-
export const component: IComponent = {
144-
async loaded(componentContext) {
145-
const studioPro = getStudioProApi(componentContext);
140+
```typescript
141+
import { IComponent, getStudioProApi } from "@mendix/extensions-api";
146142

147-
const paneHandle = await studioPro.ui.panes.register(
148-
{
149-
title: "Message Passing Pane",
150-
initialPosition: "right"
151-
},
152-
{
153-
componentName: "extension/message-passing",
154-
uiEntrypoint: "pane"
155-
}
156-
);
143+
export const component: IComponent = {
144+
async loaded(componentContext) {
145+
const studioPro = getStudioProApi(componentContext);
157146

158-
// Add a menu item to the Extensions menu
159-
await studioPro.ui.extensionsMenu.add({
160-
menuId: "message-passing.MainMenu",
161-
caption: "Message Passing",
162-
subMenus: [
147+
const paneHandle = await studioPro.ui.panes.register(
163148
{
164-
menuId: "message-passing.ShowTab",
165-
caption: "Show tab",
166-
action: async () => {
167-
await studioPro.ui.tabs.open(
168-
{
169-
title: "MyExtension Tab"
170-
},
171-
{
172-
componentName: "extension/message-passing",
173-
uiEntrypoint: "tab"
174-
}
175-
);
176-
}
149+
title: "Message Passing Pane",
150+
initialPosition: "right"
177151
},
178152
{
179-
menuId: "message-passing.ShowPane",
180-
caption: "Show pane",
181-
action: async () => {
182-
await studioPro.ui.panes.open(paneHandle);
183-
}
153+
componentName: "extension/message-passing",
154+
uiEntrypoint: "pane"
184155
}
185-
]
186-
});
187-
}
188-
};
189-
```
156+
);
157+
158+
// Add a menu item to the Extensions menu
159+
await studioPro.ui.extensionsMenu.add({
160+
menuId: "message-passing.MainMenu",
161+
caption: "Message Passing",
162+
subMenus: [
163+
{
164+
menuId: "message-passing.ShowTab",
165+
caption: "Show tab",
166+
action: async () => {
167+
await studioPro.ui.tabs.open(
168+
{
169+
title: "MyExtension Tab"
170+
},
171+
{
172+
componentName: "extension/message-passing",
173+
uiEntrypoint: "tab"
174+
}
175+
);
176+
}
177+
},
178+
{
179+
menuId: "message-passing.ShowPane",
180+
caption: "Show pane",
181+
action: async () => {
182+
await studioPro.ui.panes.open(paneHandle);
183+
}
184+
}
185+
]
186+
});
187+
}
188+
};
189+
```
190190

191191
2. Rename `src/ui/index.tsx` to `src/ui/tab.tsx` and paste the following code into it:
192192

@@ -222,7 +222,7 @@ export const component: IComponent = {
222222
</StrictMode>
223223
);
224224
}
225-
}
225+
};
226226
```
227227

228228
3. Create a new file `src/ui/pane.tsx` and paste the following code into it:

content/en/docs/deployment/private-cloud/private-cloud-cluster/networking/private-cloud-advanced-ingress-settings.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,6 @@ To integrate the Istio Service Mesh with an Ingress Controller, perform the foll
123123
6. In Istio, configure a [Gateway](https://istio.io/latest/docs/reference/config/networking/gateway/) resource to allow traffic through the ingress gateway.
124124
7. Define a [VirtualService](https://istio.io/latest/docs/reference/config/networking/virtual-service/) to route traffic from the gateway to a service in the mesh.
125125
126-
127126
To configure the Istio Service Mesh for Mendix on Kubernetes, set up the following settings:
128127
129128
* **Ingress Type** - Select **kubernetes-ingress**; this option configures the Ingress according to the additional domain name you supply.

content/en/docs/deployment/private-cloud/private-cloud-cluster/networking/private-cloud-ingress.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -287,6 +287,7 @@ Traefik uses 2 types of providers: CRDs or Kubernetes Ingress. Ensure that you i
287287
#### Configuring Traefik in the Mxpc-cli Tool
288288
289289
To configure Traefik for Mendix on Kubernetes, set up the following settings:
290+
290291
* **Ingress Type** - Select **kubernetes-ingress**; this option configures the Ingress according to the additional domain name you supply.
291292
* **Ingress Domain Name** - Provide the domain name which was registered for Traefik
292293
* **Ingress Path** - Set to `/*`.

content/en/docs/marketplace/deprecate-content/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,4 @@ A badge is now displayed across the component's Marketplace page, letting users
3434

3535
If you are a company admin or a component developer, you can deprecate both personal components, and company components.
3636
However, if the component is part of a content group, you need to be a member of that group to be able to deprecate components.
37-
For details, refer to the [Content Group](/appstore/home-page/#content-groups) section in *Marketplace Home Page*.
37+
For details, refer to the [Content Group](/appstore/home-page/#content-groups) section in *Marketplace Home Page*.

content/en/docs/marketplace/overview/marketplace-home-page.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,6 @@ Click the contextual **Actions** menu to access options for managing your conten
9393
* **Deprecate Component** – Deprecate the component, and select alternatives.
9494
For details on deprecating components, refer to [Deprecating Marketplace Content](/appstore/deprecate-content/).
9595

96-
9796
A **Private** label on a component means the component is your company's private Marketplace content. For details on how this is configured, refer to the [Adding New Marketplace Content](/appstore/submit-content/#adding) section of *Uploading to the Marketplace*. This content can be shared with [guests](#guests).
9897

9998
A component assigned as [group content](#group-content) will have a label for the [content group](#content-groups) to which it is assigned.
@@ -200,4 +199,3 @@ Download the latest version of [Studio Pro](/releasenotes/studio-pro/).
200199
Share new Marketplace content that you have developed.
201200

202201
For details, refer to [Uploading Content to the Marketplace](/appstore/submit-content/).
203-

content/en/docs/marketplace/platform-supported-content/modules/document-generation.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,6 @@ If your app is configured to [restrict access for incoming requests](/developerp
164164

165165
{{% alert color="info" %}}Each of your app environments needs to be registered separately. A successful app registration is limited to the app URL that was provided during the registration. Note that a change in the app URL, or restoring a database backup from one environment to another, will require you to register the affected app environments again.{{% /alert %}}
166166

167-
168167
### Running on self-hosted for airgapped and on-premises {#run-private-service-and-on-premises}
169168

170169
{{% alert color="info" %}} When self-hosting the Document Generation Service in an airgapped environment, the browser does not have access to the internet. As such, note that any external dependencies such as fonts, stylesheets, or images are not loaded. This could cause the document generation process to fail or result in incomplete documents. {{% /alert %}}

content/en/docs/marketplace/platform-supported-content/modules/siemens/teamcenter-extension/creating-an-integration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,4 +165,4 @@ However, you can make the following adjustments outside Teamcenter Extension:
165165
* Moving microflows
166166
* Renaming microflows
167167

168-
If you select an item in the **Action** list, Teamcenter Extension performs a validation check to see if the Teamcenter objects, entities, and microflows still exist and are valid. The results are reported in the **Validation** section.
168+
If you select an item in the **Action** list, Teamcenter Extension performs a validation check to see if the Teamcenter objects, entities, and microflows still exist and are valid. The results are reported in the **Validation** section.

0 commit comments

Comments
 (0)