-
Notifications
You must be signed in to change notification settings - Fork 791
[Control Center] Company Guidelines #11376
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
NicoletaComan
wants to merge
11
commits into
development
Choose a base branch
from
nc-company-guidelines
base: development
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 6 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
b059fb1
Company Guidelines - initial structure
NicoletaComan d4958df
Added sample reference file
NicoletaComan 8932705
Updated introduction + added RN
NicoletaComan 1c79e51
Merge branch 'development' into nc-company-guidelines
NicoletaComan b09f763
Added guideline categories
NicoletaComan de3fd05
Updated per test env
NicoletaComan 2e69245
Fixed spelling
NicoletaComan dc6d36e
Changed sample file + added new save options
NicoletaComan b02bba1
Applied feedback + changed UI item names
NicoletaComan b895ccb
Merge branch 'development' into nc-company-guidelines
NicoletaComan cf5cad8
Changed description
NicoletaComan File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| --- | ||
| title: "Maia" | ||
| url: /control-center/maia/ | ||
| description: "Describes the Maia category in the Mendix Control Center." | ||
| weight: 30 | ||
| no_list: false | ||
| --- | ||
|
|
||
| ## Introduction | ||
|
|
||
| The **Maia** section allows you to manage, control, and monitor Maia behavior on Mendix Portal. | ||
|
|
||
| ## Documents in This Category |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| --- | ||
| title: "Company Guidelines" | ||
| url: /control-center/company-guidelines/ | ||
| description: "Describes the Company Guidelines page in the Mendix Control Center." | ||
| weight: 10 | ||
| beta: true | ||
| --- | ||
|
|
||
| {{% alert color="warning" %}} | ||
| This feature is in Public Beta. For more information, refer to [Release Status](/releasenotes/release-status/). | ||
| {{% /alert %}} | ||
|
|
||
| ## Introduction | ||
|
|
||
| Without centralized guidelines, developers must manually apply your organization's architectural patterns, compliance policies, and naming conventions to every Mendix project. The **Company Guidelines** page solves this by teaching Maia your company's standards. You define guidelines in a central location, and Maia automatically applies them across all projects. This ensures consistent, compliant outputs, which are aligned with your organization's standards. | ||
|
|
||
| Company guidelines define the following: | ||
|
|
||
| * Guidelines and standards – Compliance, security, and governance policies that teams must follow. | ||
| * Reusable assets and conventions – Architecture and integration standards, development and design best practices. | ||
| * Shared terminology – Domain language and company-specific terminology. | ||
|
|
||
| When you upload company guideline documents, the system extracts and categorizes guidelines, which you can then review and approve. Once approved, these guidelines are stored in a central library, and are automatically served to Maia services. This ensures consistent AI generation across your software delivery lifecycle. | ||
|
|
||
| ## Managing Company Guidelines | ||
|
|
||
| To upload, review, and create company guidelines, follow these steps: | ||
|
|
||
| 1. Click **Upload Document**. You can upload .md, .pdf, .docx, .xlsx, and .txt format documents. For an example of what constitutes a good guideline document, check out <a href="/originals/control-center/company-guidelines/Evora Development Guidelines.pdf" target="_blank" rel="noopener noreferrer">this sample .pdf</a>. | ||
|
|
||
| 2. Once you are done uploading, click **Process Documents**. The newly uploaded documents are displayed in the **Documents that need your attention** section, pending processing and review. | ||
|
|
||
| Mendix parses and processes the uploaded documents in the background. During this time, the status of the documents is **Processing**. After processing is complete, the status changes to **Pending Review**, and a **Review Guidelines** button is displayed on the document card. | ||
|
|
||
| 3. Click **Review Guidelines** to go through the pre-processed list of guidelines and approve them. The **Review Proposed Guidelines** page is displayed, showing a list of all the guidelines in the document, along with the categories they fall under. These categories are generated and assigned by Mendix AI agents. For details on the available categories, refer to the [Guideline Categories](#guideline-categories) section of this page. | ||
|
|
||
| You can perform the following actions for each guideline in the list: | ||
|
|
||
| * Click **Mark as Reviewed** if you want to keep the guideline and its assigned categories. | ||
| * In the contextual menu, click **Edit** if you want to edit a guideline and its categories. | ||
| * In the contextual menu, click **Remove** if you want to discard the guideline. | ||
|
|
||
| You can search by guideline text, or filter by category and status. | ||
|
|
||
| 4. After you have reviewed all the guidelines in the list, click **Create Guidelines**. The guidelines are now listed on the **Company Guidelines** tab of the main page. | ||
|
|
||
| ### Guideline Categories {#guideline-categories} | ||
|
|
||
| After a document is parsed, guidelines are automatically assigned to one or more categories. These are the possible categories: | ||
|
|
||
| * Domain terminology – Guidelines in this category define what a term, concept, severity level, tier, or process state means, so agents interpret it consistently. | ||
| * Architecture and integration – Guidelines in this category govern how services communicate, integrate, or expose contracts to other systems: API contracts, protocols, payload formats, versioning, service topology, cross-system schemas. | ||
| * Data and domain modeling – Guidelines in this category govern how data is structured, named, typed, owned, classified, or modeled within or across services: entity design, field names, schema ownership, domain boundaries. | ||
| * Development standards – Guidelines in this category govern how code is written, tested, reviewed, named, built, deployed, or operated inside a single service or team: coding conventions, branch naming, internal tooling. | ||
| * Security – Guidelines in this category impose a technical control: encryption, authentication, authorization, secrets management, input validation, vulnerability management, access controls. | ||
| * Compliance and governance – Guidelines in this category impose a regulatory obligation, audit/evidence requirement, approval workflow, or governance process with an accountability trail: mandated processes, sign-offs, deadlines with owners. | ||
| * Design and brand – Guidelines in this category govern visual design, UX behaviour, copywriting, tone, or brand identity on user-facing surfaces: layouts, colors, typography, voice, accessibility. | ||
|
|
||
| ## Company Guidelines Page Tabs | ||
|
|
||
| The main **Company Guidelines** page includes the **Company Guidelines** and **Source Documents** tabs. | ||
|
|
||
| ### Company Guidelines Tab | ||
|
|
||
| The **Company Guidelines** tab lists all the guidelines that have been processed and approved, along with their categories. Each guideline has the following details: | ||
|
|
||
| * The approver | ||
| * The source document | ||
| * A contextual menu which includes the options to edit or delete the guideline | ||
|
|
||
| You can search by guideline text, or filter by category and source file. | ||
|
|
||
| ### Source Documents Tab | ||
|
|
||
| The **Source Documents** tab lists the documents from which approved guidelines originate, along with the following details: | ||
|
|
||
| * **Document name** – The name of the uploaded document. | ||
| * **Uploaded by** – The name of the user who uploaded the document. | ||
| * **Date** – The date when the document was uploaded. | ||
| * **Status** – The status of the document, which can be one of the following: | ||
| * **Processing** | ||
| * **Pending Review** – Click **Review** to go through the list of guidelines. | ||
| * **Applied** | ||
| * **Delete** – Delete the document. This deletes all of its associated guidelines. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file added
BIN
+58.1 KB
static/originals/control-center/company-guidelines/Evora Development Guidelines.pdf
Binary file not shown.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.