Skip to content

New/faq section #2269

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
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

New/faq section #2269

wants to merge 4 commits into from

Conversation

akelity
Copy link
Member

@akelity akelity commented Aug 20, 2025

Description

Update faqs section and add new faqs sub-sections

Pull Request Type

  • Documentation content changes
  • Bugfix / Missing Redirects
  • Docusaurus site code changes

PR Checklist

  • The commit message follows our guidelines included in the CONTRIBUTING.md
  • All tests of Lint, cspell and check-content pass. (How to launch them?)
  • No sensitive content has been committed

@akelity akelity requested a review from a team as a code owner August 20, 2025 08:22
In the top-right corner of the Design area, click on the branch/revision name to open the management popover. If you have unsaved changes, a "Save configuration" button will be active. Clicking it opens a modal where you must provide a commit title and an optional message. This action creates a new commit (in Standard Workflow) or a new snapshot (in Enhanced Workflow).
[Discover more](/development_suite/api-console/api-design/overview.md)

#### How can I merge configurations between two branches or revisions?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

here we can also point out that the merge of configurations may happen also when two users are currently working on the same branch/revision:
if there are remote changes and you want to make your changes too, a warning shows up when opening the action popover, telling the users that they have current local changes but there are also remote changes that should be addressed

Yes, Kustomize is fully supported. When you enable it for a project, an `overlays` directory is created in your configuration repository. Inside this directory, you can create a folder for each environment (e.g., `production`) containing patch files and a `kustomization.yaml`. These patches are applied over the base configuration at deployment time, allowing you to declaratively modify resources for specific environments.
[Discover more](/console/project-configuration/kustomize-your-configurations/index.md)

#### What is the purpose of the Design Overview?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i would not tell about the Design Overview, since in the future will be incorporated in the evolution of the software catalog

Mia-Platform follows semantic versioning with a `MAJOR.MINOR.PATCH` format:
* **MAJOR** (e.g., v14.0.0): Increased for significant new functionality or backward-incompatible changes.
* **MINOR** (e.g., v14.1.0): Increased for new features and functional improvements.
* **PATCH** (e.g., v14.1.1): Increased for bug fixes, stability, and performance improvements.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we don't strictly follow this pattern when it comes to PATCHES: sometimes we also include very small features, especially if there are only a few of them.

Copy link
Contributor

@graz-dev graz-dev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review first round

### General Concepts & Project Management

#### What is the Mia-Platform Console?
The Mia-Platform Console is a cloud-native Platform Builder that functions as an **internal developer platform** (**IDP platform**). It's designed to help organizations industrialize and govern the entire software development lifecycle. By providing a centralized **developer portal**, it simplifies cloud-native complexity, empowers development teams with self-service capabilities, and allows **platform engineers** to enforce governance and **platform engineering best practices**. The Console manages everything from infrastructure connection to API design, deployment, and monitoring.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The Mia-Platform Console is a cloud-native Platform Builder that functions as an **internal developer platform** (**IDP platform**). It's designed to help organizations industrialize and govern the entire software development lifecycle. By providing a centralized **developer portal**, it simplifies cloud-native complexity, empowers development teams with self-service capabilities, and allows **platform engineers** to enforce governance and **platform engineering best practices**. The Console manages everything from infrastructure connection to API design, deployment, and monitoring.
The Mia-Platform Console is a cloud-native Platform Builder that functions as an **Internal Developer Platform (IDP)**. It's designed to help organizations industrialize and govern the entire software development lifecycle. By providing a centralized **developer hub**, it simplifies cloud-native complexity, empowers development teams with self-service capabilities, and allows **platform engineers** to enforce governance and **platform engineering best practices**. The Mia-Platform Console manages everything from infrastructure connection to API design, deployment, and monitoring.

I think using the "portal" term here can be misleading.

[Discover more](/development_suite/overview-dev-suite.md)

#### What is a "Company" in the Mia-Platform Console?
A **Company** is the highest-level organizational unit in the Console. It acts as a container for multiple **Projects** and provides centralized governance. At the Company level, you configure shared resources that are inherited by all its projects, such as Kubernetes cluster connections, **Providers** (like Git providers and secret managers), and default project templates. This structure allows an organization to manage different business units or teams in an isolated and organized manner.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
A **Company** is the highest-level organizational unit in the Console. It acts as a container for multiple **Projects** and provides centralized governance. At the Company level, you configure shared resources that are inherited by all its projects, such as Kubernetes cluster connections, **Providers** (like Git providers and secret managers), and default project templates. This structure allows an organization to manage different business units or teams in an isolated and organized manner.
A **Company** is the highest-level organizational unit in the Mia-Platform Console. It acts as a container for multiple **Projects** and provides centralized governance. At the Company level, you configure shared resources that are inherited by all its projects, such as Kubernetes cluster connections, **Providers** (like Git providers and secret managers), and default project templates. This structure allows an organization to manage different business units or teams in an isolated and organized manner.

We should't use the term Console or products name alone.
We should always use them with the "Mia-Platform" prefix.
It's a valid feedback for the whole PR, so please check the whole content event if I didn't left an explicit suggestion.

Then I suggest to add the link to the providers page where provider are mentioned.

[Discover more](/console/company-configuration/create-company.md)

#### What is the difference between a Project and an Environment?
* A **Project** is where you build a specific application or system. It contains all the necessary configurations, including microservices, APIs, data models (CRUDs), and public variables. Each Project belongs to a Company.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* A **Project** is where you build a specific application or system. It contains all the necessary configurations, including microservices, APIs, data models (CRUDs), and public variables. Each Project belongs to a Company.
* A **Project** is where you build your services. It contains all the necessary configurations, including microservices, APIs, data models (CRUDs), and public variables. Each Project belongs to a Company.

Not always there is a 1:1 relationship between projects and application.


#### What is the difference between a Project and an Environment?
* A **Project** is where you build a specific application or system. It contains all the necessary configurations, including microservices, APIs, data models (CRUDs), and public variables. Each Project belongs to a Company.
* An **Environment** represents a specific deployment stage within a Project, such as `Development`, `Staging`, or `Production`. Each environment is mapped to a unique namespace in a Kubernetes cluster, allowing you to deploy and test your configurations in isolated runtime contexts.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* An **Environment** represents a specific deployment stage within a Project, such as `Development`, `Staging`, or `Production`. Each environment is mapped to a unique namespace in a Kubernetes cluster, allowing you to deploy and test your configurations in isolated runtime contexts.
* An **Environment** represents a specific deployment stage within a Project, such as `Development`, `Staging`, or `Production`. Each environment is mapped to a unique namespace in a Kubernetes cluster, allowing you to deploy and test your services in isolated runtime contexts.

* An **Environment** represents a specific deployment stage within a Project, such as `Development`, `Staging`, or `Production`. Each environment is mapped to a unique namespace in a Kubernetes cluster, allowing you to deploy and test your configurations in isolated runtime contexts.
[Discover more](/console/project-configuration/application-project.md)

#### What is a "Project Template" and why is it important?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@marcofilippi we shold agree here if we can keep using the "Project Template" or "Project Blueprint" wording.

[Discover more](/console/company-configuration/project-blueprint.md)

#### How do I create a new Project?
To create a new Project, you must first have a Company, a Git Provider, and a Project Template configured. From the Console homepage, click "Create Project" and follow the three-step wizard:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To create a new Project, you must first have a Company, a Git Provider, and a Project Template configured. From the Console homepage, click "Create Project" and follow the three-step wizard:
To create a new Project, you must first have a Company, a Git Provider, a CI/CD Provider, a Secret Management Provider and a Project Template configured. From the Console homepage, click "Create Project" and follow the three-step wizard:

It transforms a collection of services into a cohesive **software engineering platform**.
[Discover more](/software-catalog/overview.md)

#### What kind of assets can be managed in the Software Catalog?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This allows developers to understand the purpose and usage of an asset before adding it to their project.
[Discover more](/marketplace/overview_marketplace.md)

#### Where can I see the items I've already added to my project?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is too focused on microservices. I would suggest rephrasing the sentence like this: 'Based on the type of item instantiated (e.g., microservices, sidecars, etc), it will appear in the corresponding list within the Design section of your project.'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants