Skip to content

Commit

Permalink
docs: software catalog items management (#1789)
Browse files Browse the repository at this point in the history
* Fixed documentation

* update UI page

* Working on software catalog doc

* working on software catalog doc

* Fix images

* fix visibility page

* Fix link

* working on SC doc

* Removed marketplace management section

* Add create and delete page SC

* working on sc doc

* fix visibility page

* fix manage items page

* Fix link

* Fix spellcheck errors

* Removed unused imgs

* Update docs/software-catalog/manage-items/mia-ctl/update/overview.md

Co-authored-by: Edoardo Pessina <[email protected]>

* Update docs/software-catalog/manage-items/overview.md

Co-authored-by: Edoardo Pessina <[email protected]>

* Update docs/software-catalog/manage-items/overview.md

Co-authored-by: Edoardo Pessina <[email protected]>

* Update docs/software-catalog/manage-items/overview.md

Co-authored-by: Edoardo Pessina <[email protected]>

* fix docs

---------

Co-authored-by: Fabio Nappi <[email protected]>
Co-authored-by: Claudia Focchi <[email protected]>
Co-authored-by: Paola Nicosia <[email protected]>
Co-authored-by: epessina <[email protected]>
  • Loading branch information
5 people authored and malta895 committed Nov 25, 2024
1 parent beeb695 commit 67f1243
Show file tree
Hide file tree
Showing 49 changed files with 639 additions and 517 deletions.
40 changes: 40 additions & 0 deletions 301redirects.json
Original file line number Diff line number Diff line change
Expand Up @@ -1806,5 +1806,45 @@
"/docs/fast_data/cast_functions": {
"destination": "/docs/fast_data/configuration/cast_functions",
"addedOn": "2024-10-23"
},
"/docs/marketplace/add_to_marketplace/create_your_company_marketplace": {
"destination": "/docs/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",
"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",
"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",
"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",
"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",
"addedOn": "2024-11-19"
},
"/docs/marketplace/add_to_marketplace/manage_marketplace_items": {
"destination": "/docs/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",
"addedOn": "2024-11-19"
},
"/docs/marketplace/add_to_marketplace/change_marketplace_item_visibility": {
"destination": "/docs/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",
"addedOn": "2024-11-19"
}
}
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](/marketplace/add_to_marketplace/marketplace_items_accessibility.md).
For more information about how to share a Marketplace Resource, please refer to the [dedicated documentation page](/software-catalog/catalog-and-marketplace/overview.md).

:::info

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,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](/marketplace/add_to_marketplace/add_item_by_type/add_custom_resource.md)).
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.md)).
:::

To create a resource from Marketplace, you need to select the Infrastructure Resource you want to create.
Expand Down Expand Up @@ -125,7 +125,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](/marketplace/add_to_marketplace/add_item_by_type/add_custom_resource.md) section.
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.md) section.

### Template-based Infrastructure Resource management

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](/marketplace/add_to_marketplace/add_item_by_type/add_sidecar.md) guide.
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.
:::

#### 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](/marketplace/add_to_marketplace/add_item_by_type/add_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/manage-items/mia-ctl/create/create-item-by-type/create_plugin.md#properties-of-plugin-resources) 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 @@ -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](/marketplace/add_to_marketplace/add_item_by_type/add_custom_resource.md#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/manage-items/mia-ctl/create/create-item-by-type/create_infrastructure_resource.md#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.

:::

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 @@ -320,7 +320,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](/marketplace/add_to_marketplace/create_your_company_marketplace.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/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).
### How can I change the state of a document?
#### What is the process to change the state of a document in CRUD?
Expand Down

This file was deleted.

Loading

0 comments on commit 67f1243

Please sign in to comment.