diff --git a/content/en/docs/developerportal/_index.md b/content/en/docs/developerportal/_index.md index bbf6c06f94f..fca111ed5d9 100644 --- a/content/en/docs/developerportal/_index.md +++ b/content/en/docs/developerportal/_index.md @@ -14,27 +14,29 @@ cascade: ## Introduction -[Apps](https://sprintr.home.mendix.com) is one of the key components of the Mendix Portal. In **Apps**, you can create, deploy, and manage apps as well as collaborate with each other. After you open **Apps**, you will get a summary of your current apps, your company apps, and your pending invites. +[Apps](https://sprintr.home.mendix.com) is one of the key components of the Mendix Portal. In **Apps**, you can create, deploy, and manage apps, as well as collaborate with others. **Apps** provides a summary of your current apps, your company apps, and your pending invites. {{< figure src="/attachments/developerportal/apps-overview.png" alt="Apps Overview" >}} ## Creating an App {#create-app} -To create a new app and start collaborating, you can perform the following procedure. +Follow these steps to create a new app and start collaborating: -1. In Apps, click **Create App** in the upper-right corner. A screen opens to guide you through the process. +1. In **Apps**, click **Create App** in the upper-right corner. A screen opens to guide you through the process. {{< figure src="/attachments/developerportal/create-app-step-1.png" alt="Create App Step One" >}} 2. Enter the following information for your app: - * **App name** – Every app must have a name. + * **App name** – Every app must have a name that abides by these requirements: - The app name cannot be longer than 200 characters (but preferably, no more than 40 characters). The app name can contain letters, numbers, underscores (`_`), dashes (`-`), or white spaces (). The app name must not start with a white space. + * It cannot be longer than 200 characters, but Mendix recommends no more than 40 characters. + * It can contain letters, numbers, underscores (`_`), dashes (`-`), or white spaces (). + * It must not start with a white space. * **App description (Optional)** – Give your app a short description. This is optional. - * **App icon** – Mendix has generated an icon for your app. You can change the color of the icon if you like. You can upload a custom icon in the [App Settings](/developerportal/collaborate/general-settings/#general) page after you created the app. + * **App icon** – Mendix has generated an icon for your app. You can change the color of the icon if you like. You can upload a custom icon in the [App Settings](/developerportal/collaborate/general-settings/#general) page once you have created the app. 3. Click **Next** in the lower-right corner to go to step 2. @@ -52,9 +54,7 @@ To create a new app and start collaborating, you can perform the following proce The **My Apps** tab displays all the apps for which you are a [Team](/developerportal/general/team/) member. -If you pin an app, it stays on top. - -You can filter the overview to display only the apps that are marked for deletion. Read more about how we mark apps for deletion [here](/developerportal/deploy/mendix-cloud-deploy/#projects-deletion). +You can filter the overview to display only the apps that are marked for deletion. Read more about how we mark apps for deletion in the [Deletion of Unused Projects](/developerportal/deploy/mendix-cloud-deploy/#projects-deletion) section of *Mendix Cloud*. Use the drop-down menu on the right side of the page to sort the apps by **Pinned**, **Recent Activity** or in alphabetical order of **App Name**. @@ -89,7 +89,7 @@ The features in the navigation pane can also be accessed via APIs, enabling thir ### Pending Invitations {#pending-invitations} -If you are invited to collaborate on an app, the invitation will appear at the top of the **My Apps** page. You can accept or decline the invitation. +If you are invited to collaborate on an app, your invitation is displayed at the top of the **My Apps** page. You can accept or decline the invitation. {{% alert color="info" %}} You get an invitation only when someone invites you to an app from a different company. If someone invites you to an app from your company, you will be added automatically. diff --git a/content/en/docs/developerportal/app-insights/feedback.md b/content/en/docs/developerportal/app-insights/feedback.md index 8f51d98c74f..4b288bdce07 100644 --- a/content/en/docs/developerportal/app-insights/feedback.md +++ b/content/en/docs/developerportal/app-insights/feedback.md @@ -12,7 +12,7 @@ aliases: If your app uses the [Mendix Feedback](/appstore/modules/mendix-feedback/) module, users can report feedback to your team using the feedback widget in your app, and all their feedback goes to the **Feedback** page. **Feedback** enables your team to view all the feedback. It also allows team members with the right permissions to organize feedback and add feedback manually. -You can access the **Feedback** page by selecting your app in [Apps](https://sprintr.home.mendix.com/) and then clicking **Feedback** in the navigation pane. +You can access the **Feedback** page by selecting your app in [Apps](https://sprintr.home.mendix.com/), then clicking **Feedback** in the navigation pane. The **Feedback** page contains two tabs: [Inbox](#inbox) and [Archive](#archive). @@ -26,23 +26,32 @@ On top of getting a notification in the Mendix Portal, Scrum Masters of your tea #### What Happens to the User -After a user reports feedback in the app using the feedback widget, they get an email with a link to their submitted feedback. When the user opens the link, a page opens and shows their feedback details. See the table below: +After a user reports feedback in the app using the feedback widget, they get an email with a link to their submitted feedback. When the user opens the link, a page opens and shows their feedback details. -| What a User Can See on the Page | What a User Cannot See on the Page | -| ----------------------------------------------------------- | ----------------------------------------------------------- | -| Name of the feedback they submitted | Metadata | -| Description of the feedback they wrote | Summary of the feedback that your team wrote | -| Screenshot (if they uploaded a screenshot for the feedback) | To which team member the feedback is assigned | -| Current status of the feedback | Tags that are assigned to the feedback | -| Submission date | Other feedback items that are associated with this feedback | -| Last activity on the feedback | Attachments that you team uploaded for this feedback | -| | Team comments on this feedback | +##### What a User Can See on the Page + +* Name of the feedback they submitted +* Description of the feedback they wrote +* Screenshot (if they uploaded a screenshot for the feedback) +* Current status of the feedback +* Submission date +* Last activity on the feedback + +##### What a User Can See on the Page + +* Metadata +* Summary of the feedback that your team wrote +* To which team member the feedback is assigned +* Tags that are assigned to the feedback +* Other feedback items that are associated with this feedback +* Attachments that you team uploaded for this feedback +* Team comments on this feedback This page also has a message feature for the user to communicate with your team directly. Users can upload images in the messages. When the user posts a message, the assigned team member receives an email. When there is a reply from your team, the user gets an email notification. -{{% alert color="warning" %}}Do not share the link to feedback details with someone unless it is necessary. Anyone who has this link can access the feedback details, including the title and the description of the feedback as well as the screenshot if there is one.{{% /alert %}} +{{% alert color="warning" %}}Do not share the link to feedback details with someone unless it is necessary. Anyone who has this link can access the feedback details, including the title and the description of the feedback, as well as the screenshot if there is one.{{% /alert %}} -If the user does not want to receive notifications anymore, they can clear the checkbox for the notification on the page, as shown in the image below: +If the user does not want to receive notifications anymore, they can clear the checkbox for the notification on the page. {{< figure src="/attachments/developerportal/app-insights/feedback/user-notification.png" class="no-border" >}} @@ -73,11 +82,16 @@ Clicking the filter bar opens the **Filter by** side panel. In this side panel, ### Organizing Feedback in Inbox -If your [role](/developerportal/general/app-roles/) has the permission that **Can edit ‘Stories, Documents and Feedback'**, you can also organize feedback items. +If your [role](/developerportal/general/app-roles/) has the **Can edit ‘Stories, Documents and Feedback'** permission, you can also organize feedback items. You can add new feedback manually yourself. -To manually add feedback, click **Create new feedback** (if there is not any feedback yet on the **Inbox** tab) or click **Add feedback** (if there is already feedback on the **Inbox** tab), and then fill in the **Subject**, **Description**, and **Submitter Email** fields, and optionally **Upload Screenshots** in the **New Feedback** dialog box. +To manually add feedback: + +* Click **Create new feedback** if there is not any feedback yet in the **Inbox** tab. +* Click **Add feedback** if there is already feedback in the **Inbox** tab. + +Then, fill in the **Subject**, **Description**, and **Submitter Email** fields, and optionally **Upload Screenshots** in the **New Feedback** dialog box. If you select feedback, you can see the following items: @@ -125,18 +139,18 @@ On the [Inbox](#inbox) and [Archive](#archive) tabs, you can open feedback by cl ### Feedback Tab {#feedback} -{{% alert color="info" %}}If your [role](/developerportal/general/app-roles/) has the permission that **Can edit ‘Stories, Documents and Feedback'**, you can edit the feedback details on the **Feedback** tab.{{% /alert %}} +{{% alert color="info" %}}If your [role](/developerportal/general/app-roles/) has the **Can edit ‘Stories, Documents and Feedback'** permission, you can edit the feedback details on the **Feedback** tab.{{% /alert %}} The **Feedback** tab shows the following items: -* Buttons ({{% icon name="view-off" %}} {{% icon name="view" %}} {{% icon name="hyperlink" %}} {{% icon name="three-dots-menu-horizontal" %}}) on the upper-right corner - * {{% icon name="view-off" %}} – Clicking the button to start receiving [notifications](#notifications) for this feedback. You also automatically start receiving notifications for this feedback whenever you respond to the reporter of the feedback or leave a comment for your team in the **Communications** section within the feedback. - * {{% icon name="view" %}} – Clicking the button to stop receiving notifications for this feedback. - * **Copy Link** ({{% icon name="hyperlink" %}}) – Clicking this button copies the URL to the feedback. You can send the URL to other people. - * **More Options** ({{% icon name="three-dots-menu-horizontal" %}}) – Clicking the button opens a menu with the following items: - * **Move** – Clicking this button moves the feedback to any other app of which you are a member. Whenever you move feedback, you also move all linked feedback. If you only want to move one feedback item, you need to unlink the feedback from the group first. +* Buttons ({{% icon name="view-off" %}} {{% icon name="view" %}} {{% icon name="hyperlink" %}} {{% icon name="three-dots-menu-horizontal" %}}) in the upper-right corner + * {{% icon name="view-off" %}} – Click this button to start receiving [notifications](#notifications) for this feedback. You also automatically start receiving notifications for this feedback whenever you respond to the reporter of the feedback or leave a comment for your team in the **Communications** section within the feedback. + * {{% icon name="view" %}} – Click this button to stop receiving notifications for this feedback. + * **Copy Link** ({{% icon name="hyperlink" %}}) – Click this button to copy the URL to the feedback. You can send the URL to other people. + * **More Options** ({{% icon name="three-dots-menu-horizontal" %}}) – Click this button to open a menu with the following items: + * **Move** – Click this button to move the feedback to any other app of which you are a member. Whenever you move feedback, you also move all linked feedback. If you only want to move one feedback item, you need to unlink the feedback from the group first. * **Create Story** – If your app is connected to [Epics](/developerportal/project-management/epics/) or [Jira](/developerportal/project-management/jira-connector/), clicking this button converts the feedback to a story on the designated board in Epics or Jira. Once the story is created, clicking this button brings you to the story on the board right away. - * **Delete** – Clicking this button removes the feedback permanently from **Feedback**. The result is irreversible. + * **Delete** – Click this button to removee the feedback permanently from **Feedback**. The result is irreversible. * **Last activity** – This shows when the last edit to the feedback was made. @@ -159,7 +173,7 @@ The **Feedback** tab shows the following items: * **Metadata** – This shows a list of metadata of the feedback. * **Active Userrole** – This is the user role the reporter has in your app - * **Active form**– This is the page from which the reporter sent the feedback + * **Active form** – This is the page from which the reporter sent the feedback * **Screen Size** – This is the dimensions of the reporter’s screen in pixels * **Browser** – This is the version of the browser the reporter was using * **Application location** – This is the URL of the page from which the reporter sent the feedback @@ -229,4 +243,4 @@ You can receive a notification when new feedback lands in **Inbox** or when a re ### Receiving Notifications for an Individual Feedback Item {#notifications-individual-feedback} -You can also just receive notifications for an individual feedback item. Set this up by clicking the {{% icon name="view-off" %}} icon on the upper-right corner of the [Feedback](#feedback) tab after you open the feedback. You also automatically start receiving notifications for an individual feedback item once you [respond to the reporter](#contact-reporter) of the feedback or leave a comment for your team in the **Communications** section within the feedback. +You can also just receive notifications for an individual feedback item. Set this up by clicking the {{% icon name="view-off" %}} icon in the upper-right corner of the [Feedback](#feedback) tab after you open the feedback. You also automatically start receiving notifications for an individual feedback item once you [respond to the reporter](#contact-reporter) of the feedback or leave a comment for your team in the **Communications** section within the feedback. diff --git a/content/en/docs/developerportal/app-insights/mini-surveys.md b/content/en/docs/developerportal/app-insights/mini-surveys.md index ae3805d7c7d..f2d730ccef0 100644 --- a/content/en/docs/developerportal/app-insights/mini-surveys.md +++ b/content/en/docs/developerportal/app-insights/mini-surveys.md @@ -2,7 +2,7 @@ title: "Mini Surveys" url: /developerportal/app-insights/mini-surveys/ weight: 6 -description: "The app development team can utilize Mendix's user-friendly [Mini Surveys](/appstore/modules/mendix-mini-surveys/) module to integrate surveys into their applications. This empowers the Product Owner (PO), Scrum Master, or the development team to craft surveys with personalized customizations, including survey goals, duration, and questionnaire types. After configuring the survey, end-users can conveniently submit their responses. Subsequently, the Product Owner, Scrum Master, or the team can analyze the survey results, extracting valuable insights." +description: "The app development team can utilize Mendix's user-friendly [Mini Surveys](/appstore/modules/mendix-mini-surveys/) module to integrate surveys into their applications. This empowers the Product Owner (PO), the Scrum Master, or the development team to craft surveys with personalized customizations, including survey goals, duration, and questionnaire types. After configuring the survey, end-users can conveniently submit their responses. Subsequently, the Product Owner, the Scrum Master, or the team can analyze the survey results, extracting valuable insights." --- ## Introduction @@ -23,7 +23,7 @@ This document first describes all the pages in Mini Surveys in **Apps**, and the When you click **Mini Surveys** in the [navigation pane](/developerportal/#navigation-pane) for an app that already has existing mini surveys, the **Survey Overview** page opens first. -On the upper-left corner of the page, you can see the name of the app currently opened. Click the app name to open a drop-down list of other apps you can navigate to that have been previously opened for Mini Surveys. +In the upper-left corner of the page, you can see the name of the app currently opened. Click the app name to open a drop-down list of other apps you can navigate to that have been previously opened for Mini Surveys. The tabs of the **Survey Overview** page are described below. @@ -47,9 +47,9 @@ Click the mini survey in a row on the list to see its [survey details](#survey-d A mini survey can have different statuses. You can check the status of a mini survey on the [Active](#active) tab. -Along its lifecycle, a mini survey can have the following statuses: +Throughout its lifecycle, a mini survey can have the following statuses: -* **Draft** – This status means the mini survey is not finalized. You can still edit the survey and when you finalize it, you need to schedule it. Once you schedule a survey, its status changes to **Scheduled**. +* **Draft** – This status means the mini survey is not finalized. You can still edit it and, when you finalize it, you need to schedule it. Once you schedule a survey, its status changes to **Scheduled**. * **Scheduled** – This status means the mini survey is finalized, but its start time is not reached yet. Once the start time is reached, its status changes to **Active**. * **Active** – This status indicates that the mini survey is currently running. After the survey reaches its end time, the status will change to **Finished**. @@ -57,7 +57,7 @@ Along its lifecycle, a mini survey can have the following statuses: * **Finished** – This status means the mini survey has ended. -{{% alert color="info" %}}When a mini survey has the status of **Draft**, you can still edit everything in the survey. When a mini survey has the status of **Scheduled**, **Active**, or **Finished**, you can only edit the **Settings** section (for **Runtime** and **Toaster Placement**) in the survey.{{% /alert %}} +{{% alert color="info" %}}When a mini survey has the **Draft** status, you can still edit everything in the survey. When a mini survey has the status of **Scheduled**, **Active**, or **Finished**, you can only edit the **Settings** section (for **Runtime** and **Toaster Placement**) in the survey.{{% /alert %}} #### Archived Tab {#archived} @@ -79,7 +79,7 @@ When you click a mini survey on the [Survey Overview](#survey-overview) page, th {{< figure src="/attachments/developerportal/app-insights/mini-surveys/survey-details.png" >}} -On the upper-right corner, you can find the following buttons: +In the upper-right corner, you can find the following buttons: * **Share Link** – Clicking **Share Link** copies the link to this page, which allows you to share the survey details with others. * **Archive Survey** – Clicking **Archive Survey** archives the survey. Once a survey is archived, you can find it on the [Archived](#archived) tab of the **Survey Overview** page. @@ -94,13 +94,13 @@ This tab is available for mini surveys with all the statuses. It gives an overvi #### Responses Tab {#responses} -This tab is available for mini surveys with the status of **Active** or **Finished**. +This tab is available for mini surveys with the **Active** or **Finished** status. On this tab, you can view all the responses that have been collected for the mini survey. ### Settings Page {#settings} -When you click {{% icon name="cog" %}} **Settings** at the upper-right corner of the **Survey Overivew** page, the **Settings** page opens. Here you can change all your settings and preferences for the mini survey. There are two tabs available: **Survey Locations** and **API Key**. +When you click {{% icon name="cog" %}} **Settings** in the upper-right corner of the **Survey Overivew** page, the **Settings** page opens. Here you can change all your settings and preferences for the mini survey. There are two tabs available: **Survey Locations** and **API Key**. {{< figure src="/attachments/developerportal/app-insights/mini-surveys/settings-page.png" >}} @@ -144,7 +144,7 @@ The first time you complete the onboarding, Mendix creates a demo survey for you * **Context** * **Survey Title** – Give the mini survey a name. - * **Description** – Descirbe your survey. + * **Description** – Describe your survey. * **Start date & End date** – Set the start and end time of the mini survey. * **Survey Location** – Select the location of the mini survey widget. * **Questions** – You can set up to five questions per mini survey. @@ -152,8 +152,8 @@ The first time you complete the onboarding, Mendix creates a demo survey for you * **Score** – Create a question where a user can give a star, emoji or numerical rating. * **Multiple Choice** – Create a question where you can set up to 4 answers for the user to pick from. * **NPS** – Let the user pick a score between 0 and 10 to rate your app. - * **Finalize** – Shows an summary of your survey. - * **Toaster Placement** – Set on which corner of the page the mini survey appears. + * **Finalize** – Shows a summary of your survey. + * **Toaster Placement** – Choose the corner of the page where the mini survey is displayed. 4. Click **Preview** to see how the mini survey looks once it is live. 5. If the preview looks good, click **Schedule Survey** to complete the creation of the survey. diff --git a/content/en/docs/developerportal/digital-execution/compass.md b/content/en/docs/developerportal/digital-execution/compass.md index 1b79ef18fbc..ad3ca2a2533 100644 --- a/content/en/docs/developerportal/digital-execution/compass.md +++ b/content/en/docs/developerportal/digital-execution/compass.md @@ -28,16 +28,16 @@ After Compass has been enabled for your organization, a user with the Program Ow ### Inviting Team Members -The Compass team involved in your Mendix implementation should include everyone that will help get Mendix implemented in your organization. This team is not the same as the app project team which will build the app itself, although for example, a lead developer might be present in both. You can find out more about the team's scope and responsibilities by perusing the action points in Compass. +The Compass team involved in your Mendix implementation should include everyone that will help get Mendix implemented in your organization. This team is not the same as the app project team which will build the app itself, although, for instance, a lead developer might be present in both. You can find out more about the team's scope and responsibilities by perusing the action points in Compass. You can give members of the team access to Compass by performing the following steps: -1. Log in to [Compass](https://compass.home.mendix.com/) as a user with the Program Owner role. +1. Log in to [Compass](https://compass.home.mendix.com/) as a user with the **Program Owner** role. 2. In the left navigation menu, click **Access Management**. 3. In the **Invite Members** window, enter the email address of the user that you want to invite, and specify their role in the project. {{% alert color="info" %}} -The Program Owner role grants users access to invite other users. As a best practice, follow the principle of least privilege, and only assign this role to team members who are leading the implementation. +The **Program Owner** role grants users access to invite other users. As a best practice, follow the principle of least privilege, and only assign this role to team members who are leading the implementation. {{% /alert %}} You can invite users who are already a part of your organization, but also external users, for example, from partner organizations. Their invitations are displayed in the **Pending Invitations** tab until accepted. @@ -50,14 +50,14 @@ Milestones are key points in the implementation process that must be completed i {{< figure src="/attachments/developerportal/compass/milestones.png" alt="A screenshot of the Introduction to Digital Execution with Mendix milestone with some action points completed and others in progress" >}} -The milestones are defined for you by Mendix, based on our [Digital Execution](https://www.mendix.com/glossary/digital-execution/) framework. They do not keep track of development milestones - their role is to walk you through the steps which you must complete before development can start. +The milestones are defined for you by Mendix, based on our [Digital Execution](https://www.mendix.com/glossary/digital-execution/) framework. They do not keep track of development milestones - their role is to walk you through the steps that you must complete before development can start. {{< figure src="/attachments/developerportal/compass/milestones-home.png" alt="The Milestones page, showing some completed and open milestones" >}} You can view and manage milestones by performing the following steps: 1. In the **Program** section of the left navigation menu, click **Milestones**. -2. Click on the milestone which you want to view. +2. Click on the milestone that you want to view. 3. Click on an action point to view the details or assign an owner and deadline. 4. If you are the owner of an action point, follow the on-screen instructions to complete it. 5. To view all action points assigned to you, click **Program** > **My Action Points**. @@ -73,12 +73,12 @@ You can view and manage tasks by performing the following steps: 1. In the **Program** section, click **Tasks**. 2. To add a new task, click **Add Task**, and then provide the following information: - * **Name** - Required. An identifying name for the task. - * **Status** - By default, new tasks are created with the status **To do**, but you can also mark them as already done. - * **Description** - As a best practice, provide a detailed description, so that the person working on the task has sufficient information to complete it. - * **Deadline** - The deadline of the task. - * **Assigned to** - The team member who must complete the task. - * **Milestone** - The milestone with which the task is associated. + * **Name** — Required. An identifying name for the task. + * **Status** — By default, new tasks are created with the status **To do**, but you can also mark them as already done. + * **Description** — As a best practice, provide a detailed description, so that the person working on the task has sufficient information to complete it. + * **Deadline** — The deadline of the task. + * **Assigned to** — The team member who must complete the task. + * **Milestone** — The milestone with which the task is associated. 3. Click **Save**. @@ -102,11 +102,11 @@ As a best practice, it can be helpful to organize a workshop with your team, so The **Area of Focus** section lists the following topics to plan for and consider as part of your goal-setting. -* **People** - Goals associated with your team. For example, you may decide that you need to train five Mendix developers within the next three months. -* **Platform** - Goals to integrate Mendix into your software development lifecycle. -* **Portfolio** - The offerings where low-code can bring high value to your organization. -* **Process** - Goals associated with your business processes. For example, you may decide to implement scrum. -* **Promotion** - Goals to help you celebrate your successes and motivate your team to build with Mendix. +* **People** — Goals associated with your team. For example, you may decide that you need to train five Mendix developers within the next three months. +* **Platform** — Goals to integrate Mendix into your software development lifecycle. +* **Portfolio** — The offerings where low-code can bring high value to your organization. +* **Process** — Goals associated with your business processes. For example, you may decide to implement scrum. +* **Promotion** — Goals to help you celebrate your successes and motivate your team to build with Mendix. These focus areas are based on the [5 Ps of digital transformation](https://www.mendix.com/glossary/digital-execution/#what-are-the-5-ps-of-digital-transformation). You can define your own measurable key results for each of those areas. diff --git a/content/en/docs/developerportal/digital-execution/portfolio-management/_index.md b/content/en/docs/developerportal/digital-execution/portfolio-management/_index.md index 59f3875525f..629623079b5 100644 --- a/content/en/docs/developerportal/digital-execution/portfolio-management/_index.md +++ b/content/en/docs/developerportal/digital-execution/portfolio-management/_index.md @@ -8,7 +8,7 @@ description: "Describes the Mendix Portfolio Management app." ## Introduction -The [Portfolio Management](https://portfolio.mendix.com) tool is available to all Mendix users. It enables staying informed about initiatives and managing them in the different development stages. It provides portfolio managers, business stakeholders, and developers with everything they need to collaborate effectively in one place and bring new initiatives to the Mendix Platform. +The [Portfolio Management](https://portfolio.mendix.com) tool is available to all Mendix users. It allows you to stay informed about initiatives and to manage them in the different development stages. It provides portfolio managers, business stakeholders, and developers with everything they need to collaborate effectively in one place and bring new initiatives to the Mendix Platform. With the Portfolio Management tool, you can manage [active initiatives](/developerportal/portfolio-management/initiatives-overview/) and [archived initiatives](/developerportal/portfolio-management/archive/) in a portfolio. If you are Portfolio Managers, you can [manage access](/developerportal/portfolio-management/access-management/) and configure [portfolio settings](/developerportal/portfolio-management/portfolio-settings/) of a portfolio. @@ -36,15 +36,15 @@ The **Portfolio Landscape Overview** page contains two sections: **My Portfolios ### Portfolio Cards {#portfolio-card} -On the **Portfolio Landscape Overview** page, each card represents a portfolio. On a portfolio card, you can see the name of the portfolio, the company to which it belongs, the [privacy settings](#privacy-settings), and the avatars of Portfolio Managers (up to avatars of four Portfolio Managers). +On the **Portfolio Landscape Overview** page, each card represents a portfolio. On a portfolio card, you can see the name of the portfolio, the company to which it belongs, the [privacy settings](#privacy-settings), and the avatars of Portfolio Managers. Up to four avatars can be displayed. #### Different Privacy Settings of a Portfolio {#privacy-settings} -{{% alert color="info" %}}A Portfolio Manager change the **Privacy Settings** on the [Portfolio Settings](/developerportal/portfolio-management/portfolio-settings/) page.{{% /alert %}} +{{% alert color="info" %}}A Portfolio Manager can change the **Privacy Settings** on the [Portfolio Settings](/developerportal/portfolio-management/portfolio-settings/) page.{{% /alert %}} Currently, the privacy settings of a portfolio can be private, restricted, or open. The table below shows their differences: -| Portfolio type | Visible in the **Company Portfolios** section? | Can users access the portfolio without joining the portfolio? | Can Portfolio Manager add users to the portfolio? * | Can users apply to join the portfolio? ** | Can Mendix Admins govern the creation of the portfolio? *** | +| Portfolio type | Visible in the **Company Portfolios** section? | Can users access the portfolio without joining the portfolio? | Can Portfolio Managers add users to the portfolio? * | Can users apply to join the portfolio? ** | Can Mendix Admins govern the creation of the portfolio? *** | |-|-|-|-|-|-| | Private | {{< icon name="remove-circle-filled" color="red" >}} | {{< icon name="remove-circle-filled" color="red" >}} |{{< icon name="checkmark-circle-filled" color="green" >}}|{{< icon name="remove-circle-filled" color="red" >}}|{{< icon name="remove-circle-filled" color="red" >}}| | Restricted | {{< icon name="checkmark-circle-filled" color="green" >}} | {{< icon name="remove-circle-filled" color="red" >}} |{{< icon name="checkmark-circle-filled" color="green" >}}|{{< icon name="checkmark-circle-filled" color="green" >}}|{{< icon name="remove-circle-filled" color="green" >}}| @@ -54,7 +54,7 @@ Currently, the privacy settings of a portfolio can be private, restricted, or op ** A user can apply to join the portfolio by clicking the **Request to Join** on the portfolio card. A Portfolio Manager needs to approve this [access request](/developerportal/portfolio-management/access-management/#access-requests). -\*** If the toggle on the [Privacy Requests](/control-center/portfolios/#privacy-requests) tab is turned on in Control Center, a Mendix Admin needs to approve the creation of a restricted or open portfolio. In that case, a Mendix Admin will receive a notification about the request and can approve or reject the request from the [Control Center](/control-center/portfolios/#privacy-requests). The **Privacy Settings** of the portfolio will be **Private** until a Mendix Admin approves the request. +\*** If the toggle on the [Privacy Requests](/control-center/portfolios/#privacy-requests) tab is turned on in Control Center, a Mendix Admin needs to approve the creation of a restricted or open portfolio. In that case, a Mendix Admin receives a notification about the request, and can approve or reject the request from the [Control Center](/control-center/portfolios/#privacy-requests). The **Privacy Settings** of the portfolio are **Private** until a Mendix Admin approves the request. {{< figure src="/attachments/developerportal/portfolio-management/opened-portfolio.png" >}} diff --git a/content/en/docs/developerportal/general/buzz.md b/content/en/docs/developerportal/general/buzz.md index effc8353ecd..31381388cc6 100644 --- a/content/en/docs/developerportal/general/buzz.md +++ b/content/en/docs/developerportal/general/buzz.md @@ -8,26 +8,26 @@ description: "Describes the Mendix Buzz, which is the landing page for working o ## Introduction -Located in the [navigation pane](/developerportal/#navigation-pane) of **Apps**, Buzz lets you see your app activity as well as collaborate and share ideas with your team. +Located in the [navigation pane](/developerportal/#navigation-pane) of **Apps**, Buzz lets you see your app activity, as well as collaborate and share ideas with your team. {{< figure src="/attachments/developerportal/general/buzz/app-buzz.png" >}} -On the top of the page, you can find the following key information about your app: +At the top of the page, you can find the following key information about your app: -* The logo, name, and description of the app. +* The logo, name, and description of the app. + If no description is provided, there is a placeholder text. + If you have the **App Settings** permission, you can change the logo, name, and description of the app on the [Settings](/developerportal/collaborate/general-settings/) page. - {{% alert color="info" %}}If no description is provided, there is a placeholder text.{{% /alert %}} - - {{% alert color="info" %}}If you have the **App Settings** permission, you can change the logo, name, and description of the app on the [Settings](/developerportal/collaborate/general-settings/) page.{{% /alert %}} - -* The name of the **Company** owning the app -* The **Target Cloud** where your app is deployed, and, if the target is the public Mendix Cloud, the **License State** of the app -* The date of the **Last Commit to the Main Line** of your app; only available if you have access to the app on the Team Server -* The **Mendix Version** of your app on main line; only available if you have access to the app on the Team Server +* The name of the **Company** owning the app. +* The **Target Cloud** where your app is deployed, and, if the target is the public Mendix Cloud, the **License State** of the app. +* The date of the **Last Commit to the Main Line** of your app. This is only available if you have access to the app on the Team Server. +* The **Mendix Version** of your app on main line. This is only available if you have access to the app on the Team Server. You can see the size of your **Team** and your team members on the right side of the page. Up to 25 team members can be displayed here at a time. -Click **Invite someone to your team** ({{% icon name="add-circle" %}}) to invite new members to your team directly. Click **Show All** to go to the [Team](/developerportal/general/team/) page for the app. +Click **Invite someone to your team** ({{% icon name="add-circle" %}}) to invite new members to your team directly. + +Click **Show All** to go to the [Team](/developerportal/general/team/) page for the app. Once you have posted a comment, you can click **Edit** to **Update Message** or **Delete**. You can also **Reply in Thread** to comments left by colleagues. diff --git a/content/en/docs/developerportal/general/documents.md b/content/en/docs/developerportal/general/documents.md index 6036148be63..634cb737bb9 100644 --- a/content/en/docs/developerportal/general/documents.md +++ b/content/en/docs/developerportal/general/documents.md @@ -8,17 +8,17 @@ description: "Describes how to manage the documents in your app." ## Introduction -On the **Documents** page of the [navigation pane](/developerportal/#navigation-pane) of **Apps**, you can upload files to your app and replace existing files with newer versions. +On the **Documents** page of the [navigation pane](/developerportal/#navigation-pane) of **Apps**, you can upload files to your app, and replace existing files with newer versions. {{< figure src="/attachments/developerportal/general/documents/documents.png" class="no-border" >}} ## Actions -You can perform the actions described below via the buttons on your app's **Documents** page. To select an existing document, select the checkbox in front of the document name. +You can perform the following actions via the buttons on your app's **Documents** page. To select an existing document, select the checkbox in front of the document name. ### Uploading a Document -Click **Upload Document** to upload a new document. This will open the **Upload Document** dialog box, where you select the document to upload and leave an optional comment. +Click **Upload Document** to upload a new document. This opens the **Upload Document** dialog box, where you select the document to upload and leave an optional comment. {{% alert color="info" %}} All file types are allowed, and they are scanned for viruses by Mendix. @@ -36,9 +36,9 @@ Click **Show Details** for a document to see the description of the file, commen You can perform the following actions on this page: -* **Download** the document -* **Delete** the document -* **Upload new version** of the document +* **Download** the document. +* **Delete** the document. +* **Upload new version** of the document. ## Read More diff --git a/content/en/docs/developerportal/general/settings/_index.md b/content/en/docs/developerportal/general/settings/_index.md index e1389c870c0..efd6be85388 100644 --- a/content/en/docs/developerportal/general/settings/_index.md +++ b/content/en/docs/developerportal/general/settings/_index.md @@ -57,7 +57,10 @@ In this tab, you can find the following items: * **Delete Project** {{% alert color="info" %}} -Only users with the **App Settings** permission can change the description of the project.
Only users with the **App Settings** permission can deactivate or delete a project. For details, see [How to Leave, Delete, or Deactivate an App](/developerportal/general/leave-delete-app/). +Only users with the **App Settings** permission can do the following: + +* Change the description of the project. +* Deactivate or delete a project. For details, see [Leaving, Deleting, or Deactivating an App](/developerportal/general/leave-delete-app/). {{% /alert %}} ## Cloud Settings {#cloud-settings} @@ -80,12 +83,12 @@ Specific steps for configuring different cloud platforms are provided here: On the **Access Management** tab, you can manage and invite app users. App users are end-users who can access the deployed app on specific environments. They can use and test your deployed app, and provide feedback. -To manage users or invite users for an app deployed on a specific environment, click **Manage Users** or **Invite Users** for that environment. For more information, see the [Managing Users](#manage-users) and [Inviting Users](#invite-users) section below. +To manage users or invite users for an app deployed on a specific environment, click **Manage Users** or **Invite Users** for that environment. For more information, see the [Managing Users](#manage-users) and [Inviting Users](#invite-users) sections on this page. On the tab, you can only see the environments that satisfy the following requirements: -* [Mendix Single Sign-On](/developerportal/deploy/mendix-sso/) is implemented in the app using the [Mendix SSO](/appstore/modules/mendix-sso/) module (for more information, see [Mendix Single Sign-On](/developerportal/deploy/mendix-sso/)) -* You are currently assigned a user role in the app which allows you to manage other users (for more information, see the [User Management Properties](/refguide/user-roles/#user-management) section of *User Roles*) +* [Mendix Single Sign-On](/developerportal/deploy/mendix-sso/) is implemented in the app using the [Mendix SSO](/appstore/modules/mendix-sso/) module. For more information, refer to [Mendix Single Sign-On](/developerportal/deploy/mendix-sso/). +* You are currently assigned a user role in the app which allows you to manage other users. For more information, refer to the [User Management Properties](/refguide/user-roles/#user-management) section of *User Roles*. {{% alert color="info" %}} When deploying your application to a non-production environment, the deploying user and the Technical Contact are always assigned the Administrator user role. @@ -99,7 +102,7 @@ When you click **Manage Users** for your environment, a dialog box opens with a To remove an app user from the environment, click **Remove** by their name. -To edit an app user's roles, click **Edit** by their name. Permissions for these roles (for example, **User** or **Administrator**) correspond to what you have configured for your app's user roles in [App Security](/refguide/app-security/#user-roles) in Mendix Studio Pro. If you have created a customized role, you need to publish the app before you are able to see and assign it here. +To edit an app user's roles, click **Edit** by their name. Permissions for these roles, such as **User** or **Administrator**, correspond to what you have configured for your app's user roles in [App Security](/refguide/app-security/#user-roles) in Mendix Studio Pro. If you have created a customized role, you need to publish the app before you are able to see and assign it here. {{% alert color="info" %}} If an app user has been granted access to an app environment through a [group](/control-center/groups/), only a Mendix Admin can remove them from that environment (by removing them from that group) or edit the roles granted by that group policy. @@ -107,17 +110,15 @@ If an app user has been granted access to an app environment through a [group](/ ### Inviting Users {#invite-users} -To invite new app users to your app, click **Invite Users** for that environment or via the **Manage Users** and follow these steps: +To invite new app users to your app, click **Invite Users** within that environment or in the **Manage Users** window, and follow these steps: 1. Enter the email addresses of the end-users you want to invite. 2. Click **Include your app team** to include invitations to all the members of your [Team](/developerportal/general/team/). This may be useful, because people invited to join your team are not added as app users automatically. 3. Click **Add to invitee list**. -4. Select the role for the App User (for example, **User** or **Administrator**). Permissions for these roles correspond to what you have configured for your app's user roles in [App Security](/refguide/app-security/#user-roles) in Mendix Studio Pro. If you have created a customized role, you need to publish the app before you are able to see and assign it here. +4. Select the role for the app user (for example, **User** or **Administrator**). Permissions for these roles correspond to what you have configured for your app's user roles in [App Security](/refguide/app-security/#user-roles) in Mendix Studio Pro. If you have created a customized role, you need to publish the app before you are able to see and assign it here. 5. Click **Next** to send the invitation. -The invitee will receive an email asking them to authorize access to their Mendix account on this screen. - -After they provide authorization, they will be brought to your deployed app. +The invitee will receive an email asking them to authorize access to their Mendix account. After they provide authorization, they are directed to your deployed app. ## Project Management {#project-management} @@ -141,7 +142,7 @@ The **History** tab presents the collaboration actions for the app. On this page {{< figure src="/attachments/developerportal/general/settings/history.png" width="700" class="no-border" >}} -When you select a history item and click **Show item**, the details of the story, Sprint, or [feedback item](/developerportal/app-insights/feedback/) will be presented. +When you select a history item and click **Show item**, the details of the story, Sprint, or [feedback item](/developerportal/app-insights/feedback/) are displayed. ## Read More diff --git a/content/en/docs/developerportal/general/settings/leave-delete-app.md b/content/en/docs/developerportal/general/settings/leave-delete-app.md index 60406421044..7b5123c0cb6 100644 --- a/content/en/docs/developerportal/general/settings/leave-delete-app.md +++ b/content/en/docs/developerportal/general/settings/leave-delete-app.md @@ -1,9 +1,9 @@ --- -title: "Leave, Delete, or Deactivate an App" +title: "Leaving, Deleting, or Deactivating an App" url: /developerportal/general/leave-delete-app/ weight: 1 description: "Describes how to leave, delete, and deactivate an app in Apps." -linktitle: "Leave and Delete an App" +linktitle: "Leaving, Deleting, or Deactivating an App" aliases: - /developerportal/settings/leave-delete-app #To update these screenshots, you can log in with credentials detailed in How to Update Screenshots Using Team Apps. @@ -11,37 +11,35 @@ aliases: ## Introduction -You can create a new app in one click and leave the app just as easily when you are not using it anymore. However, if you are thinking about leaving an app, consider carefully whether you may want to use that app later for any reason. +You can create a new app with one click, and leave the app just as easily when you are not using it anymore. However, if you are thinking about leaving an app, consider carefully whether you may want to use that app later for any reason. -This how-to teaches you how to do the following: as a Scrum Master: +This how-to teaches you how to perform the following actions as a Scrum Master: -* Leave an app -* Delete an app -* Deactivate an app +* Leave an app. +* Delete an app. +* Deactivate an app. ## Prerequisites -Before you delete or deactivate an app, make sure you have completed the following prerequisites: - -* You need to have the **Scrum Master** role in your team (or a custom role with the **App Settings** permission). +To delete or deactivate an app, you need to have the **Scrum Master** role in your team, or a custom role with the **App Settings** permission. {{% alert color="info" %}}If you are a [Mendix Admin](/control-center/apps/), you can delete, deactivate, and activate all the company's apps, with or without team members for the app.{{% /alert %}} ## Leaving, Deleting, or Deactivating an App -If you want to leave and delete your app, follow these steps: +If you want to leave, delete, or deactivate your app, follow these steps: -1. Go to [Apps](https://sprintr.home.mendix.com) and select the app that you want to leave. +1. Go to [Apps](https://sprintr.home.mendix.com), and select the app for which you want to perform the action. -2. In the navigation pane, select **Settings**. +2. In the left navigation pane, select **Settings**. 3. At the bottom of the **General** tab, click one of the following buttons: - * Click **Leave App** to leave the app. - * If you leave an app that still has team members, you will leave the app directly after clicking **Leave App**. The app will still exist in the company, and it will be available for other team members. If you want to return to the team, other team members can invite you to the app again. - * If you are the only member of the team, you will get a final confirmation message. The pop-up window states the app will be **permanently deleted**, when you leave as the last member. Confirm leaving and deleting the app by clicking **Leave and Delete App**. This change cannot be reverted and will be fully deleted from your company. - * Click **Deactivate App** to deactivate the app - * Click **Delete App** to delete the app + * Click **Leave Project** to leave the app. + * If you leave an app that still has team members, your request comes into effect as soon as you click this button. The app will still exist in the company, and it will be available for other team members. If you want to return to the team, other team members can invite you to the app again. + * If you are the only member of the team, you get a final confirmation message. The pop-up window states the app will be **permanently deleted** when you leave as the last member. Confirm leaving and deleting the app by clicking **Leave and Delete App**. This change cannot be reverted and will be fully deleted from your company. + * Click **Deactivate Project** to deactivate the app. + * Click **Delete Project** to delete the app. {{% alert color="warning" %}}Only Free Apps can be deleted. App deletion cannot be undone, which means that ALL DATA WILL BE LOST, including all files on the [Team Server](/developerportal/general/team-server/) and all data in the Free App node.{{% /alert %}} diff --git a/content/en/docs/developerportal/general/team-server/_index.md b/content/en/docs/developerportal/general/team-server/_index.md index 73a105d056a..9bbfa68e401 100644 --- a/content/en/docs/developerportal/general/team-server/_index.md +++ b/content/en/docs/developerportal/general/team-server/_index.md @@ -13,9 +13,9 @@ aliases: ## Introduction -Team Server is where all the committed versions of Mendix apps are stored. Mendix Studio Pro is integrated with the Team Server, and actions like creating a new app (including a versioned model repository), updating an app, committing changes, and merging model versions are all available from Mendix Studio Pro as single-click actions. +Team Server is where all the committed versions of Mendix apps are stored. Mendix Studio Pro is integrated with the Team Server, and actions like creating a new app, which includes a versioned model repository, updating an app, committing changes, and merging model versions are all available from Mendix Studio Pro as single-click actions. -When you commit your app model changes to the Team Server in Studio Pro, you can select user stories that you have been working on. Team Server automatically creates links between user stories and the model changes, allowing you to navigate from commits to the associated requirements. +When you commit your app model changes to the Team Server in Studio Pro, you can select stories that you have been working on. Team Server automatically creates links between stories and model changes, allowing you to navigate from commits to the associated requirements. After opening your app in [Apps](https://sprintr.home.mendix.com/), on the **Team Server** page, you can see a URL to access you app, revision history, and revision details. diff --git a/content/en/docs/developerportal/general/team-server/migrate-to-git.md b/content/en/docs/developerportal/general/team-server/migrate-to-git.md index c0779e50d3e..cf535e90a3f 100644 --- a/content/en/docs/developerportal/general/team-server/migrate-to-git.md +++ b/content/en/docs/developerportal/general/team-server/migrate-to-git.md @@ -1,5 +1,5 @@ --- -title: "Migrate to Git" +title: "Migrating to Git" url: /developerportal/general/migrate-to-git/ weight: 10 description: "Describes how to migrate apps to Git." @@ -41,7 +41,7 @@ In addition to the hard criteria mentioned above, a check is performed to determ {{% alert type="info" %}} -The eligibility check does not display your repository size, and Support Engineers do not have access to this information. Additionally, deleting branches will not reduce the server-side repository size due to the way SVN manages data. +The eligibility check does not display your repository size, and Support Engineers do not have access to this information. Additionally, deleting branches does not reduce the server-side repository size due to the way SVN manages data. {{% /alert %}} @@ -59,7 +59,7 @@ For the smoothest experience after the migration, Mendix advises to [migrate wit #### Eligible for Migrating Without History -If your app is eligible for migration, but the SVN repository size exceeds the threshold, you can only migrate the latest commit of the main branch. This limitation has been imposed to guarantee a smooth experience after the migration, as a [large Git Repository Size](/refguide/troubleshoot-repository-size/) can have a negative effect on the developer experience. +If your app is eligible for migration, but the SVN repository size exceeds the threshold, you can only migrate the latest commit of the main branch. This limitation has been imposed to guarantee a smooth experience after the migration, since a [large Git repository size](/refguide/troubleshoot-repository-size/) can have a negative effect on the developer experience. {{% alert type="info" %}} @@ -67,7 +67,7 @@ You will receive a full backup of your SVN repository after completing the migra {{% /alert %}} -For more information on the process, see [Migrating Without History](#without-history) section below. +For more information on the process, see the [Migrating Without History](#without-history) section below. #### Not Eligible for Migration @@ -85,9 +85,9 @@ The first two steps need to be executed within a short timeframe. The last step ## How Migration Works -If you choose to continue, your app will permanently be migrated to Git and this will not be reversible. The process differs for migrating with or without your history. For more information, see [Migrating Without History](#without-history) and [Migrating With History](#with-history) sections below. +If you choose to continue, your app will permanently be migrated to Git, and the migration is not reversible. The process differs for migrating with or without your history. For more information, see the relevant sections on this page. -Access to SVN is disabled as soon as migration starts to prevent developers from making changes to SVN that will not be copied. If migration fails for any reason, it is rolled back and the access to SVN is restored. +Access to SVN is disabled as soon as migration starts to prevent developers from making changes to SVN that will not be copied. If migration fails for any reason, it is rolled back, and access to SVN is restored. To inform your team members about the process, two emails are sent out automatically: @@ -102,7 +102,7 @@ During migration without history, only the last revision of the main branch is c The migration should take a few minutes to complete. -After migration is completed a full backup of your SVN repository is created and made available to all Scrum Masters for a period of 90 days. They receive an email with information on how to download the backup. Several days before this backup expires all Scrum Masters on the app receive another email. +After migration is completed, a full backup of your SVN repository is created and made available to all Scrum Masters for a period of 90 days. They receive an email with information on how to download the backup. Several days before this backup expires, all Scrum Masters on the app receive another email. {{% alert color="info" %}} @@ -112,7 +112,7 @@ Inform your team members that they should commit their changes and merge them to {{% alert color="warning" %}} -All work not merged to the main branch will not be migrated to your Git repository. +Any work that was not merged to the main branch will not be migrated to your Git repository. {{% /alert %}} @@ -120,11 +120,11 @@ All work not merged to the main branch will not be migrated to your Git reposito All Scrum Masters receive an email with a link to download an SVN backup. The backup can also be accessed through `https://git-migration.home.mendix.com/p/view-backup/[repository-ID]`, where you need to fill in the *[repository-ID]*. -You can then download a *[repository-id].dump* file to your local device and you can use this file to restore the repository locally. +You can then download a *[repository-id].dump* file to your local device, and you can use this file to restore the repository locally. {{% alert color="warning" %}} -The SVN backup automatically expires after 90 days. After this time the SVN history is permanently deleted and connot be recovered. +The SVN backup automatically expires after 90 days. After this time, the SVN history is permanently deleted and cannot be recovered. {{% /alert %}} @@ -132,7 +132,7 @@ To set up your local SVN repository, follow these steps: 1. Download and Install VisualSVN Server – Use [VisualSVN Server](https://www.visualsvn.com/server/download/) and import the existing repository from the *.dump* file. This will create a locally hosted SVN repository. -2. Access the Repository – Use [TortoiseSVN](https://tortoisesvn.net/) to check the repository. This will allow you to inspect the *.mpr* file or any other files within the repository. +2. Access the Repository – Use [TortoiseSVN](https://tortoisesvn.net/) to check the repository. This allows you to inspect the *.mpr* file or any other files within the repository. {{% alert color="info" %}}To inspect files from a historical revision, use **TortoiseSVN** and select **Update to revision** to check a specific revision.{{% /alert %}} @@ -140,7 +140,7 @@ To set up your local SVN repository, follow these steps: During migration with history, all app history, including revisions for all branches, is copied from SVN to Git. -Depending on the size of your repository, the migration can take several hours to complete. If you have a large number of commits, Mendix recommends doing this when developers do not need access to the repository, for example during the night. +Depending on the size of your repository, the migration can take several hours to complete. If you have a large number of commits, Mendix recommends doing this when developers do not need access to the repository, for example, during the night. {{% alert color="info" %}} @@ -150,7 +150,7 @@ Inform your team members that they should commit their changes before starting t {{% alert color="warning" %}} -Previously deleted SVN branches will not be mapped to Git branches by the migration process and will be permanently removed. If the deleted SVN branch has not been merged to another branch beforehand, commits belonging to the deleted SVN branch will also be permanently removed. +Previously deleted SVN branches will not be mapped to Git branches by the migration process, and will be permanently removed. If the deleted SVN branch has not been merged to another branch beforehand, commits belonging to the deleted SVN branch will also be permanently removed. {{% /alert %}} @@ -158,21 +158,21 @@ Previously deleted SVN branches will not be mapped to Git branches by the migrat ### Steps for Developers -After migration, existing local copies are no longer linked to a working version control system. To be able to work on your app and store your changes in the version control system, you need to check out (re-download) the app from Team Server. Do the following: +After migration, existing local copies are no longer linked to a working version control system. To be able to work on your app and store your changes in the version control system, you need to check out, i.e. re-download, the app from Team Server. Do the following: -1. Open Studio Pro, then select the app that was migrated to Git. You can identify it by its Git icon. Click **Open** in Studio Pro to download the Git version of your app. Once this is completed you can make changes and store them in version control. +1. Open Studio Pro, then select the app that was migrated to Git. You can identify it by its Git icon. Click **Open** in Studio Pro to download the Git version of your app. Once this is completed, you can make changes and store them in version control. 2. Remove previous local copies of the app to avoid working on the wrong app version. ### Upgrade Planning -To prevent issues with rapid repository growth, we strongly recommend to upgrade to Studio Pro version 10.24 LTS as soon as possible, which will automatically convert your app to [MPRv2](/refguide10/troubleshoot-repository-size/#mprv2). +To prevent issues with rapid repository growth, we strongly recommend to upgrade to Studio Pro version 10.24 LTS as soon as possible. This will automatically convert your app to [MPRv2](/refguide10/troubleshoot-repository-size/#mprv2). ## If Migration Failed -If the migration process failed, all changes are rolled back. This means access to SVN is restored and you can keep developing your app. -You can check common causes of a failed migration below and resolve them. After that you can attempt to migrate your app again. +If the migration process failed, all changes are rolled back. This means access to SVN is restored, and you can keep developing your app. +You can check common causes of a failed migration below and resolve them. After that, you can attempt to migrate your app again. -The *most likely reason* your migration has failed is that you have branches that are invalid: they are below Mendix 9.12. To resolve this, delete or upgrade these branches. +The most likely reason your migration has failed is that you have branches that are invalid: they are below Mendix 9.12. To resolve this, delete or upgrade these branches. ## Read More diff --git a/content/en/docs/developerportal/general/team/_index.md b/content/en/docs/developerportal/general/team/_index.md index c776f8348c8..5e598784b2c 100644 --- a/content/en/docs/developerportal/general/team/_index.md +++ b/content/en/docs/developerportal/general/team/_index.md @@ -8,7 +8,7 @@ description: "Describes the Team page of Apps navigation pane." ## Introduction -Your team can include all of your colleagues working on an app. As well as developing, team members might have other roles such as ideating or reviewing. The **Team** page in the [navigation pane](/developerportal/#navigation-pane) of **Apps** enables developers from both IT and business with mixed experience levels to collaborate. +Your team can include all of your colleagues working on an app. As well as developing, team members might have other roles, such as ideating or reviewing. The **Team** page in the [navigation pane](/developerportal/#navigation-pane) of **Apps** enables developers from both IT and business with mixed experience levels to collaborate. To view and manage your team members, follow these steps: @@ -23,21 +23,21 @@ Team members with the [Scrum Master](/developerportal/general/app-roles/#team-ro On the **Overview** tab, you can do the following: -* Select a new **Role** for a team member (for details on available roles, see [App Roles](/developerportal/general/app-roles/)) -* Click **Remove** to remove a user from the team -* Click **Invite New Member** to invite a new user to the team (for more information, see the [Inviting Team Members](#inviting) section below) +* Select a new **Role** for a team member. For details on available roles, refer to [App Roles](/developerportal/general/app-roles/). +* Click **Remove** to remove a user from the team. +* Click **Invite New Member** to invite a new user to the team. For details, refer to the [Inviting Team Members](#inviting) section on this page. Navigate to the **Pending Invites** tab for an overview of all sent and unaccepted invitations. You can retract pending invitations from there. ## Inviting Team Members {#inviting} -Anyone with invitation permissions in their app role can invite new team members. When you invite a new team member, you can select a role with the same or less permissions as your own. The notable exception is when [Mendix Administrators](/control-center/company-settings/#mendix-admins) invite new team members. They can appoint any role to any team member. +Anyone with invitation permissions in their app role can invite new team members. When you invite a new team member, you can select a role with the same or less permissions as your own. The notable exception is when [Mendix Admins](/control-center/company-settings/#mendix-admins) invite new team members. They can appoint any role to any team member. To invite new team members, follow these steps: -1. Click **Invite Member** on the **Team** page or **Invite someone to your team** ({{% icon name="add-circle" %}}) next to the team in the [app Buzz](/developerportal/general/buzz/). -2. Enter the email address for the Mendix user (or users) you want to invite to the team. -3. Select an **Access Role** for the new member and click **Add**. +1. Click **Invite Member** on the **Team** page, or **Invite someone to your team** ({{% icon name="add-circle" %}}) next to the team in the [app Buzz](/developerportal/general/buzz/). +2. Enter the email address for the Mendix users you want to invite to the team. +3. Select an **Access Role** for the new members, and click **Add**. 4. Send the invitation. {{% alert color="info" %}}If you invite a Mendix user from your company to an app owned by your company, the invited user is added directly to the app's team.{{% /alert %}} diff --git a/content/en/docs/developerportal/general/team/app-roles.md b/content/en/docs/developerportal/general/team/app-roles.md index aa671aee76d..5b33f4aec5e 100644 --- a/content/en/docs/developerportal/general/team/app-roles.md +++ b/content/en/docs/developerportal/general/team/app-roles.md @@ -56,18 +56,18 @@ The responsibilities of a Technical Contact depend on whether you are hosting yo For apps in Mendix Cloud, the Technical Contact is the first point of contact for the app and can do the following: -* Receive notifications for upcoming maintenance operations on the application -* Configure the alert settings in the **Monitoring** tab of the cloud node -* Receive alerts from the Mendix app when problems arise (for example, CPU load is high, running out of disk space) -* Adjust environments (for example, resize and add new environments) +* Receive notifications for upcoming maintenance operations on the application. +* Configure the alert settings in the **Monitoring** tab of the cloud node. +* Receive alerts from the Mendix app when problems arise. Examples: CPU load is high, running out of disk space. +* Adjust environments. Examples: resize and add new environments. As the Technical Contact, you can perform all the regular operations on the Mendix Cloud node in the Mendix Portal. Additionally, you can manage the access rights of your team members so that they can deploy, stop and start the app, and perform other actions. For more information, see [Node Permissions](/developerportal/deploy/node-permissions/). -The Technical Contact is also responsible for managing licenses (as in, renewals, activations, and upgrades) and is the first point of contact for the Mendix Support department. Note that Mendix is responsible for Mendix Cloud app renewals, and you can contact your Customer Success Manager (CSM) if you want to expand your license. +The Technical Contact is also responsible for managing licenses, meaning renewals, activations, and upgrades. They are also the first point of contact for the Mendix Support department. Note that Mendix is responsible for Mendix Cloud app renewals, and you can contact your Customer Success Manager (CSM) if you want to expand your license. ### On-Premises Responsibilities -When a Mendix app is on premises, it is running on the customer's own infrastructure. For managing licenses in this scenario, Mendix sends license renewal notifications to the Technical Contact via email. As a Technical Contact, if you want to expand the license (for example, for more users), you need to contact your Account Executive. +When a Mendix app is deployed on-premises, it is running on the customer's own infrastructure. For managing licenses in this scenario, Mendix sends license renewal notifications to the Technical Contact via email. As a Technical Contact, if you want to expand the license, such as for more users, you need to contact your Account Executive. ### Changing the Technical Contact {#change-technical-contact} diff --git a/content/en/docs/developerportal/project-management/_index.md b/content/en/docs/developerportal/project-management/_index.md index 1a572ee0f0f..7a2531bc7ec 100644 --- a/content/en/docs/developerportal/project-management/_index.md +++ b/content/en/docs/developerportal/project-management/_index.md @@ -13,4 +13,4 @@ The **Project Management** category in the [navigation pane](/developerportal/#n * [Epics](/developerportal/project-management/epics/) * [Jira](/developerportal/project-management/jira-connector/) -{{% alert color="info" %}}If you are the Scrum Master of your app, you can select which tool your team uses for project management on the [Project Management](/developerportal/collaborate/general-settings/#project-management) tab on the **Settings** page of your app. {{% /alert %}} +{{% alert color="info" %}}If you are the Scrum Master of your app, you can select which tool your team uses for project management on the [Project Management](/developerportal/collaborate/general-settings/#project-management) tab of your app's **Settings** page. {{% /alert %}} diff --git a/content/en/docs/developerportal/project-management/epics/_index.md b/content/en/docs/developerportal/project-management/epics/_index.md index 3b3a65743de..f4b79a22340 100644 --- a/content/en/docs/developerportal/project-management/epics/_index.md +++ b/content/en/docs/developerportal/project-management/epics/_index.md @@ -11,15 +11,15 @@ aliases: ## Introduction -Epics is the default tool for you to manage the development process of new apps. The Epics tool enables your team members to collaborate efficiently during the app development process. It supports the Scrum workflow and Kanban workflow. +Epics is the default tool for managing the development process of new apps. The Epics tool enables your team members to collaborate efficiently during the app development process. It supports the Scrum and the Kanban workflows. ## Opening an App in Epics -Open the app in [Apps](https://sprintr.home.mendix.com/link/myapps) and then go to the [Project Management](/developerportal/project-management/) section. This sections shows all the pages of the Epics tool: +Open the app in [Apps](https://sprintr.home.mendix.com/link/myapps), then go to the [Project Management](/developerportal/project-management/) section. This sections shows all the pages of the Epics tool: * [Board](/developerportal/project-management/epics/board/) * [Planning](/developerportal/project-management/epics/planning/) * [Epics](/developerportal/project-management/epics/epics/) * [Archive Stories](/developerportal/project-management/epics/archive/) -After you open the app in Epics, you can easily switch to other apps that you have access to. To do so, click the name of the current app on the upper-left corner, and then select a different app from the drop-down list. +After you open the app in Epics, you can easily switch to other apps that you have access to. To do so, click the name of the current app in the upper-left corner, then select a different app from the drop-down list. diff --git a/content/en/docs/developerportal/project-management/epics/archive.md b/content/en/docs/developerportal/project-management/epics/archive.md index 5d27ee2a21b..e64d51b56b0 100644 --- a/content/en/docs/developerportal/project-management/epics/archive.md +++ b/content/en/docs/developerportal/project-management/epics/archive.md @@ -9,8 +9,8 @@ description: "Describes the Archive page in Epics." Every time you complete a Sprint, all the stories that are **Done** are archived automatically. You can also archive a story and a swimlane manually by doing the following: -* Click **More Options** ({{% icon name="three-dots-menu-horizontal" %}}) on the upper-right corner of a [story card](/developerportal/project-management/epics/board/#story-card) or the [swimlane](/developerportal/project-management/epics/board/#swimlane) on the **Board** page and then select **Archive**. -* Click **More Options** ({{% icon name="three-dots-menu-horizontal" %}}) at the end of a [row](/developerportal/project-management/epics/planning/) on the **Planning** page and then select **Archive**. +* Click **More Options** ({{% icon name="three-dots-menu-horizontal" %}}) in the upper-right corner of a [story card](/developerportal/project-management/epics/board/#story-card) or the [swimlane](/developerportal/project-management/epics/board/#swimlane) on the **Board** page, then select **Archive**. +* Click **More Options** ({{% icon name="three-dots-menu-horizontal" %}}) at the end of a [row](/developerportal/project-management/epics/planning/) on the **Planning** page, then select **Archive**. All the archived stories are moved to the **Archived** page. @@ -32,7 +32,7 @@ If a feedback item was linked to your archived story, you will see it with a pur On the top of the page, you can search a story in the search box, based on story title, tags, epic name, and story ID. -You can click **Export to Excel** on the upper-right corner of the page to [export all the archived stories](#export-archived-stories) to an Excel file. +You can click **Export to Excel** in the upper-right corner of the page to [export all the archived stories](#export-archived-stories) to an Excel file. ## Archived Sprint Details {#archived-sprint-details} @@ -53,9 +53,7 @@ When you click the Sprint name in a row of an archived story on the **Archived** ## Exporting Archived Stories {#export-archived-stories} -On the upper-right corner of the **Archive** page, you can find the **Export to Excel** button. This allows you to export all the archived stories to an Excel file. - -To export archived stories, perform these steps: +In the upper-right corner of the **Archive** page, you can find the **Export to Excel** button. This allows you to export all the archived stories to an Excel file. To do that, follow these steps: 1. Click **Export to Excel**. The **Excel Export** dialog box opens. 2. Click **Export to Excel** to download the exported data. @@ -67,7 +65,7 @@ To export archived stories, perform these steps: * **Assigned to** – This shows the person to whom the story was assigned. * **Archived by** – This shows the person who archived the story. * **Description** – This is the description of the story. - * **Story type** – This specifies whether the story is a **Feature** or **Bug**. + * **Story type** – This specifies whether the story is a **Feature** or a **Bug**. * **Story points** – This shows the story points. * **Epic id** – This is the unique ID of the epic to which the story is linked in Epics. * **Tags** – This shows the tags for the story. diff --git a/content/en/docs/developerportal/project-management/epics/board.md b/content/en/docs/developerportal/project-management/epics/board.md index 23d9109048b..9aeee218cb2 100644 --- a/content/en/docs/developerportal/project-management/epics/board.md +++ b/content/en/docs/developerportal/project-management/epics/board.md @@ -6,15 +6,22 @@ description: "Describes the Board page in Epics. This page looks different, depe --- ## Introduction -The **Board** page gives an overview of all the stories that your team is currently working on. The stories are groups in different swimlanes based on their status. +The **Board** page gives an overview of all the stories that your team is currently working on. The stories are grouped in swimlanes based on their status. -On the upper-right corner of the page, you can find the following items: +In the upper-right corner of the page, you can find the following items: -* **Create Story** – Clicking this enables you to create a new story. +* **Create Story** – Enables you to create a new story. + You can also use **Maia Create User Story**, an AI-assisted tool, to create a user story for you. To access it, click **Create Story**, then choose the **Create with Maia** option. + Note that this option is disabled by default. To enable it, open the **Settings** by clicking the **...** button next to **Create Story**, then, on the **Mendix AI Assistance** tab, toggle the option on. Only Scrum Masters can modify this setting. - {{% alert color="info" %}}You can also use **Maia Create User Story**, an AI-assisted tool, to create a user story for you. To access it, click **Create Story**, the option to **Create with Maia** appears at the left side of **Create Story**. It is disabled by default. To enable it, open the **Settings** by clicking the **...** next to **Create Story** and toggle the **Maia Assistance** option on. Note that only Scrum Masters can modify this setting.{{% /alert %}} +* **Create Epic** – Enables you to create a new epic. -* **Create Epic** – Clicking this enables you to create a new epic. +* **Settings** — Enables you to configure board settings, as follows: + + * Configure tags. + * Switch between the Scrum and Kanban board types. + * Configure toast notifications. + * Choose whether to use Maia in Epics. * Search box – You can search stories based on story title, tags, epic name, assignee (including unassigned stories), and story ID. You can use the search box in combination with the filter. @@ -26,15 +33,15 @@ You can add more custom swimlanes, such as **In Progress**, **In Review**, and * {{< figure src="/attachments/developerportal/project-management/epics/board/add-swimlane.png" width="500px" class="no-border" >}} -You can rename, archive, or delete a swimlane as follows: click **More Options** ({{% icon name="three-dots-menu-horizontal" %}}) on the upper-right corner of the swimlane, and then select the corresponding option. +You can rename, archive, or delete a swimlane by clicking **More Options** ({{% icon name="three-dots-menu-horizontal" %}}) in the upper-right corner of the swimlane, then selecting the corresponding option. {{< figure src="/attachments/developerportal/project-management/epics/board/rename-archive-delete-swimlane.png" class="no-border" >}} However, it is not possible to do the following actions: -* Delete a swimlane if it still contains stories -* Archive a swimlane if it contains no stories -* Delete the default swimlanes: **To Do** and **Done** +* Delete a swimlane if it still contains stories. +* Archive a swimlane if it contains no stories. +* Delete the default swimlanes: **To Do** and **Done**. You can move a swimlane by dragging it to the new location. @@ -68,7 +75,7 @@ You can click a story card to view the [story details](#story-details). When you click the card of a story, the story details dialog box opens. -On the upper-right corner, you can click **Copy Link** ({{% icon name="hyperlink" %}}) to copy the link to the story. Click **More Options** ({{% icon name="three-dots-menu-horizontal" %}}) to open a menu that allows you to clone, archive, or delete the story. +In the upper-right corner, you can click **Copy Link** ({{% icon name="hyperlink" %}}) to copy the link to the story. Click **More Options** ({{% icon name="three-dots-menu-horizontal" %}}) to open a menu that allows you to clone, archive, or delete the story. {{< figure src="/attachments/developerportal/project-management/epics/board/story-details-page-icons.png" class="no-border" >}} @@ -76,8 +83,8 @@ The story details dialog box shows the following items: * **Description** – This is the description of the story: * You can edit the description of the story by clicking **Edit Description** and making changes in the WYSIWYG editor. The editor supports different text formats, including code blocks. - * You can link a story in the editor by typing *#* and the story title, and then selecting the right story from the list. - * 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 story, the system will send a notification to the tagged person. + * You can link a story in the editor by typing *#* and the story title, then selecting the story from the list. + * You can type a person in the editor by typing *@*, and the person's name, then selecting the person from the list. Once you save the story, the system sends a notification to the tagged person. * **Created by** – This shows the person who created the story. @@ -87,7 +94,7 @@ The story details dialog box shows the following items: * **Tasks** – All the tasks are listed. * You can add a task by clicking **+ Add Task**. - * You can move a task upwards or downwards by dragging them around. + * You can move a task upwards or downwards by dragging it around. * **Story Type** – You can set the story type to **Bug** or **Feature**. @@ -102,50 +109,34 @@ The story details dialog box shows the following items: * **Attached Files** – You can add attached files by clicking **+**. * **Audit Trail** – This gives information on all the updates related to the story, including who did the update and when: + * Story assigned to {user name} - - * Story assigned to {user name} from {user name} - - * Story unassigned from {user name} - - * Changed Status to {status} - - * Story type changed to {story type} - - * Task {task name} added - - * Task {task name} completed - - * Task {task name} deleted - - * Epic {epic name} linked - - * Epic {epic name} unlinked - - * Tag (or tags) {tag names} added - - * Tag (or tags) {tag names} removed - - * Story points changed to {story points} - - * File attached {file name} - - * File removed {file name} - - * Story archived - - * Comment Deleted - + * Story assigned to {user name} from {user name} + * Story unassigned from {user name} + * Changed Status to {status} + * Story type changed to {story type} + * Task {task name} added + * Task {task name} completed + * Task {task name} deleted + * Epic {epic name} linked + * Epic {epic name} unlinked + * Tag (or tags) {tag names} added + * Tag (or tags) {tag names} removed + * Story points changed to {story points} + * File attached {file name} + * File removed {file name} + * Story archived + * Comment Deleted * Comment Edited {{< figure src="/attachments/developerportal/project-management/epics/board/audit-trail.png" class="no-border" >}} * **Revision** – This shows the revision history of a story. This feature is only available for apps that use Git for version control. -* **Comment** – You can type your comment in the text box and then click **Post Your Comments** to save and post the comment. - * You can sort the comments by clicking the **Newest** or **Oldest** button. +* **Comment** – You can type your comment in the text box, then click **Post Your Comments** to save and post the comment. + You can sort the comments by clicking the **Newest** or **Oldest** button. -{{% alert color="info" %}}You can also edit the story in this story details dialog box. If you make any change, click **Save Story** at the bottom to save it.{{% /alert %}} +{{% alert color="info" %}}You can also edit the story in this story details dialog box. If you make any changes, click **Save Story** at the bottom to save it.{{% /alert %}} ## Scrum Board vs Kanban Board {#different-boards} @@ -163,7 +154,7 @@ The upper-left corner of the page shows the name of the current Sprint, when the The main area of the page gives an overview of all the stories in your current Sprint. When you commit changes in Studio Pro, you can link your commit to stories of the current Sprint in the [Commit](/refguide/commit-dialog/) dialog box. -{{% alert color="info" %}}To edit or end the current Sprint, you should go to the [Planning](/developerportal/project-management/epics/planning/#scrum-planning) page, click **More Options** ({{% icon name="three-dots-menu-horizontal" %}}) on the upper-right corner, and select the corresponding item.{{% /alert %}} +{{% alert color="info" %}}To edit or end the current Sprint, you should go to the [Planning](/developerportal/project-management/epics/planning/#scrum-planning) page, click **More Options** ({{% icon name="three-dots-menu-horizontal" %}}) in the upper-right corner, and select the corresponding item.{{% /alert %}} ### Kanban Board diff --git a/content/en/docs/developerportal/project-management/epics/epics.md b/content/en/docs/developerportal/project-management/epics/epics.md index d56ce5ae6d4..0d04f93b1d6 100644 --- a/content/en/docs/developerportal/project-management/epics/epics.md +++ b/content/en/docs/developerportal/project-management/epics/epics.md @@ -8,7 +8,7 @@ description: "Describes the Epics page in Epics." ## Introduction -The **Epics** page gives an overview of all the epics for your current app. You can use the filter on the upper-right corner to filter epics by their status: **All**, **Completed**, **In Progress**, or **Not Started**. Clicking the **Create Epics** button enables you create a new epic. +The **Epics** page offers an overview of all the epics for your current app. You can use the filter on the upper-right corner to filter epics by their status: **All**, **Completed**, **In Progress**, or **Not Started**. Clicking the **Create Epics** button enables you create a new epic. Each row represents an epic. @@ -29,7 +29,7 @@ Clicking a row opens the [epic details](#epic-details) dialog box. When you click an epic, the epic details dialog box opens. -On the upper-right corner, there is a **Copy Link** icon ({{% icon name="hyperlink" %}}) and a **More Options** icon ({{% icon name="three-dots-menu-horizontal" %}}). Clicking **Copy Link** copies the link to the epic. Clicking **More Options** opens a pop-up menu that allows you to delete the epic. +In the upper-right corner, there is a **Copy Link** icon ({{% icon name="hyperlink" %}}) and a **More Options** icon ({{% icon name="three-dots-menu-horizontal" %}}). Clicking **Copy Link** copies the link to the epic. Clicking **More Options** opens a pop-up menu that allows you to delete the epic. {{< figure src="/attachments/developerportal/project-management/epics/epics/epic-details-page-ellipsis.png" class="no-border" >}} diff --git a/content/en/docs/developerportal/project-management/epics/planning.md b/content/en/docs/developerportal/project-management/epics/planning.md index 38a579c8574..cb96c486295 100644 --- a/content/en/docs/developerportal/project-management/epics/planning.md +++ b/content/en/docs/developerportal/project-management/epics/planning.md @@ -22,17 +22,17 @@ Each row shows the following information about a story: * Linked epic * Tags * Number of comments -* Number of the tasks +* Number of tasks * Story points * To whom the story is assigned -On the upper-left corner of the page, you can use the search box to search stories based on story title, tags, epic name, assignee (including unassigned stories), story type (type *bug* or *feature*) and story ID. You can use the search box in combination with the filter. +In the upper-left corner of the page, you can use the search box to search stories based on story title, tags, epic name, assignee (including unassigned stories), story type (enter *bug* or *feature*) and story ID. You can use the search box in combination with the filter. -On the upper-right corner of the page, you can see two buttons: +In the upper-right corner of the page, you can see two buttons: -* **Create Story** – Clicking this enables you to create a new story. - - {{% alert color="info" %}}You can also use **Maia Create User Story**, an AI-assisted tool, to create a user story for you. To access it, click **Create Story**, the option to **Create with Maia** appears at the left side of **Create Story**. It is disabled by default. To enable it, open the **Settings** by clicking the **...** next to **Create Story** and toggle the **Maia Assistance** option on. Note that only Scrum Masters can modify this setting.{{% /alert %}} +* **Create Story** – Clicking this enables you to create a new story. + You can also use **Maia Create User Story**, an AI-assisted tool, to create a user story for you. To access it, click **Create Story**, then choose the **Create with Maia** option. + Note that this option is disabled by default. To enable it, open the **Settings** by clicking the **...** button next to **Create Story**, then, on the **Mendix AI Assistance** tab, toggle the option on. Only Scrum Masters can modify this setting. * **More Options** ({{% icon name="three-dots-menu-horizontal" %}}) – Clicking this shows the following options: * **Create Epic** – This enable you to create an epic. @@ -62,11 +62,11 @@ To move multiple stories, select these stories, choose the category name where t {{< figure src="/attachments/developerportal/project-management/epics/planning/move-multiple-stories.png" class="no-border" >}} -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, and then select the corresponding option: +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: {{< figure src="/attachments/developerportal/project-management/epics/planning/archive-delete-story-kanban.png" class="no-border" >}} -To archive or delete multiple stories, select these stories, and then click the corresponding option at the bottom of the page. +To archive or delete multiple stories, select these stories, then click the corresponding option at the bottom of the page. #### Keyboard Shortcuts For Selecting Stories{#keyboard-shortcuts} @@ -81,7 +81,7 @@ For Windows, you can use the following keyboard shortcuts to select stories on t ## Scrum Planning vs Kanban Planning {#different-plannings} -The **Planning** page offers different features to accommodate two different workflows: Scrum or Kanban. Depending on your choice of board type – Scrum or Kanban, the **Board** page looks a bit different. +The **Planning** page offers different features to accommodate two different workflows: Scrum or Kanban. Depending on your choice of board type — Scrum or Kanban —, the **Board** page looks a bit different. {{% alert color="info" %}}You can select your board type on the [Planning](/developerportal/project-management/epics/planning/#board-type) page.{{% /alert %}} @@ -97,16 +97,16 @@ In the main area of the page, stories are grouped in these categories: **Active On the upper-right corner, you can find these Scrum items if you click **More Options** ({{% icon name="three-dots-menu-horizontal" %}}): -* **Start Sprint** – Clicking this allows you to start a new Sprint. Once a Sprint is created, all the items in the **Next Sprint** are moved to the **Active Sprint** automatically. - * This is available only when there is no Sprint running at this moment. -* **Edit Sprint** – Clicking this allows you to edit the current Sprint. When you end a Sprint, the system shows you how many stories were completed in that Sprint. All the completed stories are archived automatically, and you can decide where the unfinished stories should go. - * This is available only when this is a Sprint running at this moment. -* **End Sprint** – Clicking this allows you to end the current Sprint. - * This is available only when this is a Sprint running at this moment. +* **Start Sprint** – Clicking this allows you to start a new Sprint. Once a Sprint is created, all the items in the **Next Sprint** are moved to the **Active Sprint** automatically. + This is available only when there is no Sprint running at that moment. +* **Edit Sprint** – Clicking this allows you to edit the current Sprint. + This is available only when there is a Sprint running at that moment. +* **End Sprint** – Clicking this allows you to end the current Sprint. When you end a Sprint, the system shows you how many stories were completed in that Sprint. All the completed stories are archived automatically, and you can decide where the unfinished stories should go. + This is available only when there is a Sprint running at that moment. ### Kanban Planning {#kanban-planning} -If your board type is Kanban, the stories are grouped in these categories: **To Do**, **Refinement**, and **Backlog**. On the top of each category, you can see the total number of stories and points. +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. {{< figure src="/attachments/developerportal/project-management/epics/planning/kanban-planning.png" class="no-border" >}} @@ -114,7 +114,7 @@ If your board type is Kanban, the stories are grouped in these categories: **To You can import your stories using an Excel file to Epics as follows: -1. On the upper-right corner of the **Planning** page, click **More Options** ({{% icon name="three-dots-menu-horizontal" %}}) and then click **Import Stories**. +1. In the upper-right corner of the **Planning** page, click **More Options** ({{% icon name="three-dots-menu-horizontal" %}}) and then click **Import Stories**. {{< figure src="/attachments/developerportal/project-management/epics/planning/import-stories.png" class="no-border" >}} @@ -148,7 +148,7 @@ You can import your stories using an Excel file to Epics as follows: 5. Go back to the **Import Stories from Excel** dialog box. -6. Click **Browse**, navigate to the Excel file, and then select it. +6. Click **Browse**, navigate to the Excel file, then select it. 7. Click **Continue**. The dialog box gives a preview of all the stories that will be imported. @@ -160,16 +160,20 @@ You can find all the imported stories in the **Backlog**. You can export your stories on the **Planning** page to an Excel file as follows: -1. On the upper-right corner of the **Planning** page, click **More Options** ({{% icon name="three-dots-menu-horizontal" %}}) and then click **Export Stories**. +1. On the upper-right corner of the **Planning** page, click **More Options** ({{% icon name="three-dots-menu-horizontal" %}}), then click **Export Stories**. {{< figure src="/attachments/developerportal/project-management/epics/planning/export-stories.png" class="no-border" >}} -2. Select from where you want to export stories. +2. Select where you want to export stories from. 3. Click **Continue** to see a preview of the Excel file. 4. Click **Export to Excel**. ## Board Settings {#settings} -When you click **More Options** ({{% icon name="three-dots-menu-horizontal" %}}) on the upper-right corner of the **Planning** page, and select **Board Settings**, a dialog box opens with four tabs: **Manage Tags**, **Board Type**, and **Toast Settings**. These tabs are described in the sections below. +When you click **More Options** ({{% icon name="three-dots-menu-horizontal" %}}) in the upper-right corner of the **Planning** page, and select **Board Settings**, a dialog box with these tabs opens: + +* **Manage Tags** +* **Board Type** +* **Toast Settings** {{< figure src="/attachments/developerportal/project-management/epics/planning/board-settings.png" class="no-border" >}} @@ -177,13 +181,15 @@ When you click **More Options** ({{% icon name="three-dots-menu-horizontal" %}}) On this tab, you can add, rename, and delete tags, as well as change tag colors. The changes here affect all the tags in your app. -To add a tag, click **+Add Tag**, enter the name, select a color, and then click **Save** {{% icon name="checkmark-circle" %}} to save it. +#### Available Actions + +* To add a tag, click **+Add Tag**, enter the name, select a color, then click **Save** {{% icon name="checkmark-circle" %}} to save it. -To rename a tag, double-click the tag name, change the name in the text box, and then click outside the text box to save it. +* To rename a tag, double-click the tag name, change the name in the text box, and then click outside the text box to save it. -To delete a tag, hover over the row of the tag, and then click the **Cancel** button ({{% icon name="remove" %}}) that appears at the end of the row. +* To delete a tag, hover over the row of the tag, and then click the **Cancel** button ({{% icon name="remove" %}}) that appears at the end of the row. -To change the tag color, click the current color, and then select the new color from the dialog box. +* To change the tag color, click the current color, then select the new color from the dialog box. ### Board Type {#board-type} diff --git a/content/en/docs/developerportal/project-management/jira-connector.md b/content/en/docs/developerportal/project-management/jira-connector.md index a37955240d6..312acdf3bf8 100644 --- a/content/en/docs/developerportal/project-management/jira-connector.md +++ b/content/en/docs/developerportal/project-management/jira-connector.md @@ -14,15 +14,15 @@ If you are a Scrum Master of a Mendix app, you can link your app to Jira if you ## Features -* Supports connecting your Mendix app to Jira -* Supports Scrum, Kanban, and team-managed boards (previously known as "next-gen boards") -* Allows you to associate your commits in Studio Pro (version 7.19 or above) to Jira stories: +* Supports connecting your Mendix app to Jira. +* Supports Scrum, Kanban, and team-managed boards, previously known as next-gen boards. +* Allows you to associate your commits in Studio Pro, version 7.19 or above, to Jira stories: - * For a Scrum board, the **Stories** pane shows all stories from all your active Sprints, ordered by story key - * For a Kanban board, the **Stories** pane shows all stories from your board, taking the sub-query of the board settings into account, ordered by story key - * For a team-managed board, the **Stories** pane shows all stories from your board, which may include your backlog; if you do not wish to see backlog stories in Studio Pro, consider setting up your board without a backlog and use a separate board to manage your backlog + * For a Scrum board, the **Stories** pane shows all stories from all your active Sprints, ordered by story key. + * For a Kanban board, the **Stories** pane shows all stories from your board, taking the sub-query of the board settings into account, ordered by story key. + * For a team-managed board, the **Stories** pane shows all stories from your board, which may include your backlog. If you do not wish to see backlog stories in Studio Pro, consider setting up your board without a backlog, and using a separate board to manage your backlog. -* Converting your [feedback items](/developerportal/app-insights/feedback/) in App Insights will result in a story in Jira +* Converting your [feedback items](/developerportal/app-insights/feedback/) in App Insights will result in a story in Jira. ## Limitations @@ -57,14 +57,14 @@ To connect your app to Jira, perform the following steps: Fill in the information as follows: - * **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`. + * **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`. * **Project Key**: This is the unique key of your project within the Jira platform. * **Admin User**: This is the login name of a user on the Jira platform with project administration rights. * **API Token**: This is a valid API token issued by the Jira platform and assigned to the above-mentioned admin user. For more information on how to get this API token, see [Manage API tokens for your Atlassian account](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/). 5. Click **Next**. -6. If your Jira project has several boards configured, from the drop-down list, select one of the Jira boards to connect. We support Scrum, simplified Scrum, and Kanban board types. +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. {{< figure src="/attachments/developerportal/project-management/jira-connector/connect-jira-board.png" >}} @@ -78,7 +78,7 @@ Once the activation is completed, your app is connected to Jira. You can see the * If you connect your app to a Kanban board, the **Stories** pane shows all stories from your board, taking the filter and sub-query of the board settings into account, ordered by story key. * You can find the filters and sub-query in the board settings in Jira (for more information, see [Configure a company-managed board](https://support.atlassian.com/jira-software-cloud/docs/configure-a-company-managed-board/)). * If you connect your app to a team-managed board, the **Stories** pane shows all stories from your board, which may include your backlog. - * If you do not wish to see backlog stories in Studio Pro, consider setting up your board without a backlog and use a separate board to manage your backlog. + * If you do not wish to see backlog stories in Studio Pro, consider setting up your board without a backlog, and using a separate board to manage your backlog. * The list of stories is ordered by the Jira story key. * After you commit your changes in Studio Pro, you can see the associated Jira stories in the details of the corresponding [revision](/developerportal/general/team-server/#revision-details) in the **Team Server** page after opening your app in **Apps**. @@ -94,6 +94,6 @@ After you activated the Jira connector, you can review the configuration details If you need to connect to a different Jira environment, or need to rotate the API key used by the Jira connector, click **Edit Connection Details**. If you want to switch to a different Jira board within the same environment, click **Change Board**. -In order for the Jira connector to work, Mendix caches some information from your Jira board in our system. This include the name of the esitimation field that you use to set story points, as well as the status schema that you use in your board. If this information changes in Jira, you may need to refresh the cache by clicking **Reconnect**. +In order for the Jira connector to work, Mendix caches some information from your Jira board in our system. This include the name of the estimation field that you use to set story points, as well as the status schema that you use in your board. If this information changes in Jira, you may need to refresh the cache by clicking **Reconnect**. If you no longer wish to use the Jira connector, simply click **Deactivate Connection**. This will revert your project management tool automatically to [Epics](/developerportal/project-management/epics/).