Skip to content

Commit dd1cde6

Browse files
committed
Adapted text around screenshots
1 parent ed9e10a commit dd1cde6

11 files changed

Lines changed: 23 additions & 33 deletions

File tree

content/en/docs/developerportal/general/documents.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ To download a document, click **Download** ({{% icon name="download-bottom" %}})
3030

3131
### Viewing the Details
3232

33-
Click **Show Details** for a document to see the description of the file, comments, and all the versions of the document:
33+
Click **Show Details** for a document to see the description of the file, comments, and all the versions of the document.
3434

3535
{{< figure src="/attachments/developerportal/general/documents/document-details.png" class="no-border" >}}
3636

content/en/docs/developerportal/general/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Located in the [navigation pane](/developerportal/#navigation-pane) of **Apps**,
1414

1515
{{< figure src="/attachments/developerportal/general/overview/project-overview.png" >}}
1616

17-
At the top of the page, you will find key information about your app, such as its logo, name, and description. If no description is provided, there is a placeholder text. With the **App Settings** permission, you can change the logo, name, and description of the app on the [Settings](/developerportal/collaborate/general-settings/) page.
17+
At the top of the page, you can find key information about your app, such as its logo, name, and description. If no description is provided, there is a placeholder text. With the **App Settings** permission, you can change the logo, name, and description of the app on the [Settings](/developerportal/collaborate/general-settings/) page.
1818

1919
On the right side of the page, you can find the following information about your app:
2020

content/en/docs/developerportal/general/settings/_index.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,13 @@ The page header displays the following information:
3737
* The company that owns the app.
3838
* The **Watch** / **Stop Watching** toggle – You can enable or disable notifications for this app.
3939

40-
{{< figure src="/attachments/developerportal/general/settings/general-information.png" class="no-border" >}}
41-
4240
{{% alert color="info" %}}
4341
Only users with the **App Settings** permission can edit the image and the app name.
4442
{{% /alert %}}
4543

4644
## General {#general}
4745

48-
In this tab, you can find the following items:
46+
On this tab, you can find the following items:
4947

5048
* Logo of the project
5149
* **Description** of the project

content/en/docs/developerportal/general/team/app-roles.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Mendix Admins can edit and create new team roles within the company in [Control
4040

4141
## Technical Contact {#technical-contact}
4242

43-
Every deployed app has a Technical Contact. When you view the [Settings](/developerportal/collaborate/general-settings/#general) for a deployed app, you can see the app's Technical Contact. The Technical Contact is the user you can contact with questions related to the app.
43+
Every deployed app has a Technical Contact. When you view the [Settings](/developerportal/collaborate/general-settings/#general) for a deployed app, you can see the app's Technical Contact. The Technical Contact is the user you can get in touch with for questions related to the app.
4444

4545
{{< figure src="/attachments/developerportal/general/team/app-roles/technical-contact.png" alt="" class="no-border" >}}
4646

content/en/docs/developerportal/project-management/epics/archive.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The **Archive** page shows all the archived stories.
2626
* Linked epic – Clicking this shows the epic details.
2727
* Archive date and time – Clicking this shows the story details.
2828

29-
If a feedback item was linked to your archived story, you will see it with a purple icon:
29+
If a feedback item was linked to your archived story, it is accompanied by a purple icon.
3030

3131
{{< figure src="/attachments/developerportal/project-management/epics/archive/archive.png" class="no-border" >}}
3232

content/en/docs/developerportal/project-management/epics/board.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ You can move a swimlane by dragging it to the new location.
5959

6060
### Story Cards {#story-card}
6161

62-
Each card in a swimlane represents a story:
62+
Each card in a swimlane represents a story.
6363

6464
{{< figure src="/attachments/developerportal/project-management/epics/board/story-card.png" class="no-border" >}}
6565

@@ -75,7 +75,7 @@ A story card shows the following details:
7575
* ⑧ Points of the story
7676
* ⑨ To whom the story is assigned
7777

78-
You can [archive](/developerportal/project-management/epics/archive/) or delete a story as follows: click **More Options** ({{% icon name="three-dots-menu-horizontal" %}}) on the upper-right corner of the card, and then select the corresponding option:
78+
You can [archive](/developerportal/project-management/epics/archive/) or delete a story by clicking **More Options** ({{% icon name="three-dots-menu-horizontal" %}}) in the upper-right corner of the card, then selecting the corresponding option.
7979

8080
{{< figure src="/attachments/developerportal/project-management/epics/board/archive-delete-story.png" class="no-border" >}}
8181

content/en/docs/developerportal/project-management/epics/epics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ In the upper-right corner, there is a **Copy Link** icon ({{% icon name="hyperli
3535

3636
The epic details dialog box shows the following items:
3737

38-
* **Objective** – This is the description of the epic:
38+
* **Objective** – This is the description of the epic.
3939
* You can edit the objective of the epic by clicking **Edit Objective** and making changes in the WYSIWYG editor. The editor supports different text formats, including code blocks
4040
* You can link a story in the editor by typing *#* and the story title, and then selecting the right story from the list.
4141
* You can type a person in the editor by typing *@* and the person's name, and then selecting the right person from the list. Once you save the epic, the system will send a notification to the tagged person.

content/en/docs/developerportal/project-management/epics/planning.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ description: "Describes the Planning page in Epics. This page looks different, d
99

1010
The **Planning** page shows all your stories.
1111

12-
The main area of the **Planning** page lists all the stories in different categories. Each row represents a story:
12+
The main area of the **Planning** page lists all the stories in different categories. Each row represents a story.
1313

1414
{{< figure src="/attachments/developerportal/project-management/epics/planning/story-kanban.png" class="no-border" >}}
1515

@@ -74,7 +74,7 @@ To move multiple stories, select these stories, choose the category name where t
7474

7575
{{< figure src="/attachments/developerportal/project-management/epics/planning/move-multiple-stories.png" class="no-border" >}}
7676

77-
To [archive](/developerportal/project-management/epics/archive/) or delete a story, click **More Options** ({{% icon name="three-dots-menu-horizontal" %}}) at the end of the row, then select the corresponding option:
77+
To [archive](/developerportal/project-management/epics/archive/) or delete a story, click **More Options** ({{% icon name="three-dots-menu-horizontal" %}}) at the end of the row, then select the corresponding option.
7878

7979
{{< figure src="/attachments/developerportal/project-management/epics/planning/archive-delete-story-kanban.png" class="no-border" >}}
8080

@@ -101,7 +101,8 @@ The **Planning** page offers different features to accommodate two different wor
101101

102102
If your board style is Scrum, you can find the features below which accommodate your Scrum workflow.
103103

104-
If there is an active Sprint, on the upper-left corner, you can find the name of the Sprint, when it ends, and how many stories and points it has. If you hover over the goal icon, you can see the goal of the Sprint:
104+
If there is an active Sprint, in the upper-left corner, you can find the name of the Sprint, when it ends, and how many stories and points it has.
105+
If you hover over the goal icon, you can see the goal of the Sprint.
105106

106107
{{< figure src="/attachments/developerportal/project-management/epics/planning/scrum-planning.png" class="no-border" >}}
107108

@@ -118,18 +119,16 @@ On the upper-right corner, you can find these Scrum items if you click **More Op
118119

119120
### Kanban Planning {#kanban-planning}
120121

121-
If your board type is Kanban, the stories are grouped in these categories: **To Do**, **Refinement**, and **Backlog**. At the top of each category, you can see the total number of stories and points.
122+
If your board type is Kanban, the stories are grouped in these categories: **To Do**, **Refinement**, and **Backlog**.
123+
At the top of each category, you can see the total number of stories and points.
122124

123125
{{< figure src="/attachments/developerportal/project-management/epics/planning/kanban-planning.png" class="no-border" >}}
124126

125127
## Importing Stories {#import-stories}
126128

127129
You can import your stories using an Excel file to Epics as follows:
128130

129-
1. In the upper-right corner of the **Planning** page, click **More Options** ({{% icon name="three-dots-menu-horizontal" %}}) and then click **Import Stories**.
130-
131-
{{< figure src="/attachments/developerportal/project-management/epics/planning/import-stories.png" class="no-border" >}}
132-
131+
1. In the upper-right corner of the **Planning** page, click **More Options** ({{% icon name="three-dots-menu-horizontal" %}}), then click **Import Stories**.
133132
The **Import Stories From Excel** dialog box opens.
134133

135134
2. Click **Download** to download the Excel file template.
@@ -172,9 +171,7 @@ You can find all the imported stories in the **Backlog**.
172171

173172
You can export your stories on the **Planning** page to an Excel file as follows:
174173

175-
1. On the upper-right corner of the **Planning** page, click **More Options** ({{% icon name="three-dots-menu-horizontal" %}}), then click **Export Stories**.
176-
177-
{{< figure src="/attachments/developerportal/project-management/epics/planning/export-stories.png" class="no-border" >}}
174+
1. In the upper-right corner of the **Planning** page, click **More Options** ({{% icon name="three-dots-menu-horizontal" %}}), then click **Export Stories**.
178175
2. Select where you want to export stories from.
179176
3. Click **Continue** to see a preview of the Excel file.
180177
4. Click **Export to Excel**.
@@ -209,6 +206,6 @@ On this tab, you can switch between a Scrum workflow and Kanban workflow. The wo
209206

210207
### Toast Settings
211208

212-
On this tab, you can enable or disable the toast notifications that appear like this:
209+
On this tab, you can enable or disable the toast notifications that are displayed along the screen.
213210

214211
{{< figure src="/attachments/developerportal/project-management/epics/planning/toast-notification.png" width="500px" class="no-border" >}}

content/en/docs/developerportal/project-management/jira-connector.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,8 @@ To connect your app to Jira, perform the following steps:
5151

5252
3. Go to the **Project Management** tab.
5353

54-
4. Click **Connect Jira**. The **Set Up Jira Configuration** dialog box opens.
55-
56-
{{< figure src="/attachments/developerportal/project-management/jira-connector/set-up-jira-configuration.png" class="no-border" >}}
57-
58-
Fill in the information as follows:
54+
4. Click **Connect Jira**. The **Set Up Jira Configuration** dialog box opens.
55+
Fill in the information as follows:
5956

6057
* **URL Jira Environment**: This is the URL of your company’s environment within the Jira platform, as provided by Jira. This URL usually looks like this: `https://my-company.atlassian.net`.
6158
* **Project Key**: This is the unique key of your project within the Jira platform.
@@ -66,8 +63,6 @@ To connect your app to Jira, perform the following steps:
6663

6764
6. If your Jira project has several boards configured, from the drop-down list, select one of the Jira boards to connect. We support the Scrum, simplified Scrum, and Kanban board types.
6865

69-
{{< figure src="/attachments/developerportal/project-management/jira-connector/connect-jira-board.png" >}}
70-
7166
7. Click **Activate** to activate the connection.
7267

7368
Once the activation is completed, your app is connected to Jira. You can see the following:
@@ -86,7 +81,7 @@ Once the activation is completed, your app is connected to Jira. You can see the
8681

8782
{{< figure src="/attachments/developerportal/project-management/jira-connector/navigation-jira.png" >}}
8883

89-
## View Settings
84+
## Viewing Settings
9085

9186
After you activated the Jira connector, you can review the configuration details any time.
9287

content/en/docs/mendix-portal/global-navigation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The global navigation top bar and menu are available throughout Mendix Portal, a
1313

1414
## Global Navigation Menu {#global-navigation}
1515

16-
On the left side of the top bar, click **Open Global Navigation** ({{% icon name="layout-rounded-1" %}}) to access the main menu:
16+
On the left side of the top bar, click **Open Global Navigation** ({{% icon name="layout-rounded-1" %}}) to access the main menu.
1717

1818
{{< figure src="/attachments/developerportal/global-nav/navigation-menu.png" width="250" class="no-border" >}}
1919

@@ -23,7 +23,7 @@ Click the menu items to navigate to different parts of Mendix Portal, or hover o
2323

2424
In the **Search** box, you can search the portal for **Docs**, **Forum** posts, public **Marketplace** content, and **Academy** content.
2525

26-
Use the various filters to refine your search results:
26+
Use the various filters to refine your search results.
2727

2828
{{< figure src="/attachments/mendix-portal/global-nav/portal_search.png" class="no-border" >}}
2929

0 commit comments

Comments
 (0)