Skip to content

Review Software Catalog documentation #2008

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

Merged
merged 38 commits into from
Apr 22, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
663e683
Start new structure
epessina Feb 21, 2025
bd143f7
update doc SC
Feb 21, 2025
5b898b6
added new SC section
Feb 26, 2025
aa19297
Structure
epessina Feb 26, 2025
5c17fae
update doc sc
Feb 27, 2025
629ff8f
Proxy resources
epessina Feb 27, 2025
6f74c79
structure
Feb 27, 2025
fd3b9f6
add lifecycle section
Mar 5, 2025
9094336
add overview
Mar 27, 2025
71d668c
fix typo
Mar 27, 2025
0cc498e
update doc sc
Apr 9, 2025
b1abc6c
stucture
epessina Apr 10, 2025
a2fe794
added sc ui and miactl
Apr 10, 2025
7f9baf6
wip basic concepts
Apr 14, 2025
33c505f
wip: items schemas
epessina Apr 14, 2025
f9314f0
list item ui
Apr 15, 2025
c472e43
items types
epessina Apr 14, 2025
a6041fd
items-versioning
Apr 15, 2025
a6c8930
fixed lifecycle
Apr 15, 2025
4bd6bff
items-management overview
Apr 15, 2025
5c955cd
fix item
Apr 15, 2025
e177d3c
update images
Apr 16, 2025
79e242f
fix typo
Apr 16, 2025
3fcfc27
visibility
epessina Apr 17, 2025
4838a63
api page
epessina Apr 17, 2025
78b6773
added links and imgs
Apr 17, 2025
72b5eb4
permissions
epessina Apr 17, 2025
70858be
versioning
Apr 17, 2025
57a45c9
versioning
Apr 17, 2025
7703425
overview runtime components
Apr 18, 2025
0ed72e3
versioning
epessina Apr 18, 2025
5275d3d
wip move marketplace
epessina Apr 18, 2025
c3374d5
marketplace section
epessina Apr 18, 2025
9bf68c1
miactl
epessina Apr 18, 2025
3500d57
remove old software catalog doc
epessina Apr 18, 2025
4ea0c93
tutorial
epessina Apr 22, 2025
fd3c7b8
manifests
epessina Apr 22, 2025
6516276
fix check-content
epessina Apr 22, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions 301redirects.json
Original file line number Diff line number Diff line change
Expand Up @@ -1808,47 +1808,47 @@
"addedOn": "2024-10-23"
},
"/docs/marketplace/add_to_marketplace/create_your_company_marketplace": {
"destination": "/docs/software-catalog/manage-items/overview-manage-items",
"destination": "/docs/old_software-catalog/manage-items/overview-manage-items",
"addedOn": "2024-11-19"
},
"/docs/marketplace/add_to_marketplace/add_item_by_type/add_plugin": {
"destination": "/docs/software-catalog/manage-items/mia-ctl/create/create-item-by-type/create_plugin",
"destination": "/docs/old_software-catalog/manage-items/mia-ctl/create/create-item-by-type/create_plugin",
"addedOn": "2024-11-19"
},
"/docs/marketplace/add_to_marketplace/add_item_by_type/add_template_or_example": {
"destination": "/docs/software-catalog/manage-items/mia-ctl/create/create-item-by-type/create_template_or_example",
"destination": "/docs/old_software-catalog/manage-items/mia-ctl/create/create-item-by-type/create_template_or_example",
"addedOn": "2024-11-19"
},
"/docs/marketplace/add_to_marketplace/add_item_by_type/add_application": {
"destination": "/docs/software-catalog/manage-items/mia-ctl/create/create-item-by-type/create_application",
"destination": "/docs/old_software-catalog/manage-items/mia-ctl/create/create-item-by-type/create_application",
"addedOn": "2024-11-19"
},
"/docs/marketplace/add_to_marketplace/add_item_by_type/add_sidecar": {
"destination": "/docs/software-catalog/manage-items/mia-ctl/create/create-item-by-type/create_sidecar",
"destination": "/docs/old_software-catalog/manage-items/mia-ctl/create/create-item-by-type/create_sidecar",
"addedOn": "2024-11-19"
},
"/docs/marketplace/add_to_marketplace/add_item_by_type/add_custom_resource": {
"destination": "/docs/software-catalog/manage-items/mia-ctl/create/create-item-by-type/create_infrastructure_resource",
"destination": "/docs/old_software-catalog/manage-items/mia-ctl/create/create-item-by-type/create_infrastructure_resource",
"addedOn": "2024-11-19"
},
"/docs/marketplace/add_to_marketplace/manage_marketplace_items": {
"destination": "/docs/software-catalog/manage-items/overview-manage-items",
"destination": "/docs/old_software-catalog/manage-items/overview-manage-items",
"addedOn": "2024-11-19"
},
"/docs/marketplace/add_to_marketplace/marketplace_items_accessibility": {
"destination": "/docs/software-catalog/catalog-and-marketplace/overview-catalog-and-marketplace",
"destination": "/docs/old_software-catalog/catalog-and-marketplace/overview-catalog-and-marketplace",
"addedOn": "2024-11-19"
},
"/docs/marketplace/add_to_marketplace/change_marketplace_item_visibility": {
"destination": "/docs/software-catalog/catalog-and-marketplace/overview-catalog-and-marketplace",
"destination": "/docs/old_software-catalog/catalog-and-marketplace/overview-catalog-and-marketplace",
"addedOn": "2024-11-19"
},
"/docs/marketplace/add_to_marketplace/declarative_marketplace": {
"destination": "/docs/software-catalog/manage-items/declarative-approach",
"destination": "/docs/old_software-catalog/manage-items/declarative-approach",
"addedOn": "2024-11-19"
},
"/docs/software-catalog/manage-items/mia-ctl/overview-mia-ctl": {
"destination": "/docs/software-catalog/manage-items/mia-ctl/overview-miactl",
"/docs/old_software-catalog/manage-items/mia-ctl/overview-mia-ctl": {
"destination": "/docs/old_software-catalog/manage-items/mia-ctl/overview-miactl",
"addedOn": "2024-12-04"
},
"/docs/data_catalog/data_catalog_frontend": {
Expand Down
5 changes: 4 additions & 1 deletion check-content.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,10 @@ const filesToExcludeFromSidebarCheck = [
"standalone-resources/*",
"fast_data/runtime_management/snippets/*",
"fast_data/snippets/*",
"development_suite/api-console/api-design/videos/subtitle/*"
"development_suite/api-console/api-design/videos/subtitle/*",
"software-catalog/basic-concepts/*",
"software-catalog/snippets/*",
"software-catalog/tutorials/*",
]

const checkIdRegexp = new RegExp('^---(\\n.*)+id:\\s+([-\\w. ]+)(.*\\n)+---$', 'm')
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_label: Manage Marketplace Providers
When adding a new Provider connection, you can choose to define it as a "**Marketplace**" Provider.

By doing so, you can decide to make any resources related to that specific **Provider** available to other Companies.
For more information about how to share a Marketplace Resource, please refer to the [dedicated documentation page](/software-catalog/catalog-and-marketplace/overview.md).
For more information about how to share a Marketplace Resource, please refer to the [dedicated documentation page](/software-catalog/overview.md).

:::info

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ In creation, you will see the preview of the generated manifest.
#### Create an Infrastructure Resource from Marketplace

:::info
To allow users to add a Infrastructure Resource to their project from marketplace, you need to apply it using `miactl` ([see here for details](/software-catalog/manage-items/mia-ctl/create/create-item-by-type/create_infrastructure_resource.mdx)) or using [`Software Catalog`](/software-catalog/manage-items/mia-ctl/create/create-item-by-type/create_infrastructure_resource.mdx)
To allow users to add a Infrastructure Resource to their project from marketplace, you need to apply it to your Company Software Catalog ([see here for details](/software-catalog/items-management/overview.md)).
:::

To create a resource from Marketplace, you need to select the Infrastructure Resource you want to create.
Expand Down Expand Up @@ -131,7 +131,7 @@ Users with appropriate permissions can manage the lifecycle of a Infrastructure

Infrastructure Resources are published to the Marketplace using the `custom-resource` type in the marketplace item schema. Versioning is supported, allowing users to make updates without overwriting previous versions of the Infrastructure Resource.

To learn more on how to add or manage a Infrastructure Resource in the Marketplace, see the [Add Custom Resource to the Marketplace](/software-catalog/manage-items/mia-ctl/create/create-item-by-type/create_infrastructure_resource.mdx) section.
To learn more on how to add or manage a Infrastructure Resource in the Marketplace, see the [dedicated section](/software-catalog/items-management/overview.md) section.

### Template-based Infrastructure Resource management

Expand All @@ -152,7 +152,7 @@ resources:
archive: https://example.com/path/to/archive.zip
...
```
Refer to [Infrastructure Resource definition](/software-catalog/manage-items/mia-ctl/create/create-item-by-type/create_infrastructure_resource.mdx#infrastructure-resource-definition) schema
Refer to [Infrastructure Resource definition](/software-catalog/items-manifest/infrastructure-resource.md) schema
:::


Expand Down
2 changes: 1 addition & 1 deletion docs/console/design-your-projects/sidecars.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ If you want to create a new instance of a sidecar you are already using in some

:::tip
It is possible to define and publish sidecar resource definitions on the Marketplace.
Find out more in the [Publish your sidecar to the Marketplace](/software-catalog/manage-items/mia-ctl/create/create-item-by-type/create_sidecar.md) guide.
Find out more in the [dedicated section](/software-catalog/items-management/overview.md).
:::

#### Clone a sidecar
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ patches:
With the example above, the `istio-proxy` container will be added to deployments with **all the specified labels and annotations**.

:::info
You can apply labels to microservices inside the Design section of the Mia-Platform Console, or, in case of Self-Hosted installation, you can [set default labels](/software-catalog/manage-items/mia-ctl/create/create-item-by-type/create_plugin.md#properties-of-plugin-resources) to the microservices created from Marketplace.
You can apply labels to microservices inside the Design section of the Mia-Platform Console, or, in case of Self-Hosted installation, you can [set default labels](/software-catalog/items-manifest/plugin.md) to the microservices created from Marketplace.
:::

### Enable **High Availability** for business critical microservices
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ Next, proceed to set up the application. When searching in the marketplace, sear
- the _AI RAG Chat_, which is the application where the _RAG Chatbot API_ is provided in form of a [Plugin](/plugins/mia-platform-plugins.md), maintained and supported by the Mia-Platform team
- the _AI RAG Chat Template_, which is the application where the _RAG Chatbot API_ is provided in form of a [Template](/marketplace/templates/mia_templates.md) that will create a repository in your Git provider; while this template represents all the features of the plugin and it is fully functional, you can modify it by adding or removing features according to your needs

![AI RAG Chat applications in Marketplace](../img/ai-rag-chat-in-marketplace.png)
![AI RAG Chat applications in Marketplace](./img/ai-rag-chat-in-marketplace.png)

It will prompt you to create the _API Gateway_ (you can use the previously created one with the available listener), the _RAG Chatbot API_, and the _AI RAG Template Chat_, along with several endpoints to expose the service APIs for sending questions and generating embeddings.

Expand Down Expand Up @@ -203,7 +203,7 @@ The content of `vectorStore` is the same as the one described in the previous se
From the _deploy_ section, you can deploy the new configuration. After verifying that the services are up, we can check if the application is running by accessing the chatbot frontend.
The frontend is accessible through the automatically generated endpoint `/` (e.g., if the project is hosted at `https://my-project.console.my-company.com`, the frontend will be accessible at the same URL).

![Assistant Playground homepage](../img/assistant-playground-home.png)
![Assistant Playground homepage](./img/assistant-playground-home.png)

The frontend will display a page with an input field where you can communicate with the chatbot.
However, at this point, there are no embeddings, so specific questions may not give us the expected response.
Expand Down Expand Up @@ -239,7 +239,7 @@ With this information, you have all the knowledge needed to generate the embeddi

From the _API Portal_ you can make a request to the `api/embeddings/generate` API by expanding the corresponding card and clicking on "Try it out".

![Embeddings generate API](../img/embeddings-generate-api.png)
![Embeddings generate API](./img/embeddings-generate-api.png)

In the request body, the following information are needed:

Expand Down Expand Up @@ -277,7 +277,7 @@ You can call the API multiple times, and when the response includes `{ "status":
If you need to generate embeddings from a file, you can use to the `api/embeddings/generateFromFile` API, accessible from the _API Portal_.
By expanding the corresponding card and clicking on "Try it out", you will see that this time it is required to upload a file.

![Embeddings generateFromFile API](../img/embeddings-generate-from-file-api.png)
![Embeddings generateFromFile API](./img/embeddings-generate-from-file-api.png)

By clicking on _Choose file_ you can select a file to upload.
Supported files are the following:
Expand All @@ -298,7 +298,7 @@ As explained above, you can check the status of the process by calling the `/api

Once the process is over, there's no need to re-deploy or restart any service: after a few moments, the MongoDB Vector Index will be updated and the frontend application will be ready to give us meaningful answers based on the generated embeddings.

![Assistant Playground working](../img/assistant-playground-working.png)
![Assistant Playground working](./img/assistant-playground-working.png)

## Troubleshooting

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ If deployed, the information on the [Custom Resources](/console/design-your-proj
:::caution
If you created one or more Custom Kubernetes Resource from a marketplace template **prior** to Console release v13.3.0, the resources **will not be visible by default**.

Please ensure to [update your resource](/software-catalog/manage-items/mia-ctl/create/create-item-by-type/create_infrastructure_resource.mdx#update-a-custom-resource-to-the-console-v1330) version via [miactl](/cli/miactl/10_overview.md) to one that has the properties `resourceId` and `type` correctly set in the `runtime` object field of its definition, otherwise the Custom Kubernetes Resources won't be visible in the section even if the resource is active.
Please ensure to [update your resource](/software-catalog/items-manifest/infrastructure-resource.md) version via [miactl](/cli/miactl/10_overview.md) to one that has the properties `resourceId` and `type` correctly set in the `runtime` object field of its definition, otherwise the Custom Kubernetes Resources won't be visible in the section even if the resource is active.

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/faqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,7 @@ No, it's not mandatory. However, starting from a [Mia-Platform Template](/market
### Can I create my own templates?
#### How can I create custom templates for my microservices?
Yes, you can. Follow this [guideline](/software-catalog/manage-items/overview.md) and [open an issue with the Marketplace contribution template](https://github.com/mia-platform/community/issues/new?labels=marketplace&template=marketplace-contribution.md&title=Add+new+marketplace+item).
Yes, you can. Follow this [guideline](/software-catalog/items-management/overview.md) and [open an issue with the Marketplace contribution template](https://github.com/mia-platform/community/issues/new?labels=marketplace&template=marketplace-contribution.md&title=Add+new+marketplace+item).
### How can I change the state of a document?
#### What is the process to change the state of a document in CRUD?
Expand Down
1 change: 0 additions & 1 deletion docs/getting-started/handbooks/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ Welcome to the handbooks section! Here, you'll find comprehensive guides designe

- **Project Development in Console**: Learn how to develop projects effectively in the console. [Go to project-development.mdx](/console/handbooks/project-development.mdx).
- **Connect and Manage Cluster**: Step-by-step guide on connecting and managing clusters. [Go to connect-and-manage-cluster.md](/console/company-configuration/clusters-management/connect-and-manage-cluster.mdx).
- **CRUD Service OSS Usage**: Delve into how to use the CRUD service with OSS. [Go to crud-oss-usage.mdx](/marketplace/handbooks/crud-oss-usage.mdx).
- **Traefik Handbook**: Comprehensive insights into Traefik. [Go to traefik-handbook.mdx](/console/handbooks/traefik-handbook.mdx).

## How to Use This Section
Expand Down
4 changes: 0 additions & 4 deletions docs/libraries/mia-service-libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,3 @@ Currently available libraries are:
| [Mia service NET library](https://github.com/mia-platform/Mia-service-Net-Library) | .NET, C# |

More libraries are in development, but if you need to create microservices in a specific language or framework and feel the need for a library, you can [build your own yourself](/libraries/create-new-library.md).

:::info
Would you like your library to appear here? Send an email with all the details to [info@mia-platform.eu](mailto:info@mia-platform.eu)
:::
2 changes: 1 addition & 1 deletion docs/marketplace/examples/mia_examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ Mia-Platforms currently supports the following examples:

Their code is open source, feel free to open a PR to contribute to any of them!

If you want to create your own example, head to the [Create your Company Marketplace](/software-catalog/manage-items/overview.md) page for further information.
If you want to create your own example, head to the [dedicated page](/software-catalog/items-management/overview.md) page for further information.
Loading