Skip to content

Commit

Permalink
feat: change contributing_overview to create_your_company_marketplace
Browse files Browse the repository at this point in the history
  • Loading branch information
ThisIsDemetrio authored and ThisIsDemetrio committed Sep 24, 2024
1 parent 69f5ba0 commit d13d93b
Show file tree
Hide file tree
Showing 12 changed files with 20 additions and 19 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -160,5 +160,5 @@ 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/contributing_overview.md#common-to-microservice-items-plugins-templates-examples) 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](/marketplace/add_to_marketplace/add_item_by_type/add_plugin.md#properties-of-plugin-resources) to the microservices created from Marketplace.
:::
2 changes: 1 addition & 1 deletion docs/getting-started/faqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ Microservices templates, using [Mia-Platform Service Libraries](/libraries/mia-s

### Can I create my own templates?

Yes, you can. Follow this [guideline](/marketplace/add_to_marketplace/contributing_overview.md) and [open an issue here with the Marketplace contribution template](https://github.com/mia-platform/community/issues/new?labels=marketplace&template=marketplace-contribution.md&title=Add+new+marketplace+item). We will be happy to help you!
Yes, you can. Follow this [guideline](/marketplace/add_to_marketplace/create_your_company_marketplace.md) and [open an issue here with the Marketplace contribution template](https://github.com/mia-platform/community/issues/new?labels=marketplace&template=marketplace-contribution.md&title=Add+new+marketplace+item). We will be happy to help you!

### Is communication between microservice available with protocols others than HTTP?

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Only the `services` field must be configured for an application configuration to

### Configure Services

The `service` object has the same structure found in the Plugins, Templates and Examples, as explained in the [dedicated paragraph](/marketplace/add_to_marketplace/contributing_overview.md#common-to-microservice-items-plugins-templates-examples).
The `service` object has the same structure found in the Plugins, Templates and Examples, as explained in the [dedicated paragraph](/marketplace/add_to_marketplace/add_item_by_type/add_plugin.md#properties-of-plugin-resources).

Thus, if you plan to add a plugin, a template, or an example to your application you can follow the same configuration. Remember to add general details to every microservice, such as name and description.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,20 @@ title: Create a Plugin
sidebar_label: Create a Plugin
---

Plugins are ready-to-use microservices that only need some configuration from the user to work.

To configure a Plugin, make sure you followed the [common Marketplace item creation steps](/marketplace/add_to_marketplace/contributing_overview.md#creation-of-a-marketplace-item), then follow the paragraphs below to finalize the configuration.
Plugins are ready-to-use microservices that only need some configuration from the user to work. They are defined by the *type* field with value `plugin` in the item document.

## Where to host plugins

The plugin must be hosted as a **Docker image**.

The Docker image should be pushed on an accessible registry.
The Docker image should be pushed on an accessible registry.
If you wish to use the **Mia-Platform private registry**, your Mia-Platform referent will provide the credentials to do it.

The Docker image must be specified in the `dockerImage` field in the service Marketplace document.

:::info
In versioned marketplace plugins, the `dockerImage` field depends on the version of the plugin used to install the microservice to the project. This means that, in the *Design* section, the `dockerImage` field is *read-only*, and cannot be modified, unless the user decides to detach the microservice or update the plugin to a different Marketplace item version.

The service documentation of your plugin will be accessible from a specific link in the Marketplace, you also need to provide the documentation URL of your plugin and this must be inserted in the `documentation` field:

```json
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This guide aims to assist the reader in transforming Marketplace items concernin

:::info

To create a Marketplace item, whether it's private or public, please follow [this](/marketplace/add_to_marketplace/contributing_overview.md) dedicated guide.
To create a Marketplace item, please follow [this](/marketplace/add_to_marketplace/create_your_company_marketplace.md) dedicated guide.

:::

Expand All @@ -20,7 +20,7 @@ In the event that you need to port an item originally available in the public Ma

Once the Mia-Platform team receives the request and assesses its feasibility, they will grant authorization to proceed with the porting and monitor migration activities. After obtaining the authorization to proceed with the porting, you will need to create a repository on your Git Provider and migrate the code of the item you want to transfer. During this phase, if necessary, you will also need to configure your CI/CD pipelines.

Once the repository configuration is complete, the final operational step involves creating the Item Configuration following the [guide for creating Marketplace items](/marketplace/add_to_marketplace/contributing_overview.md). At this point, it's essential to notify the Mia-Platform maintenance team of the completion of the preceding steps, either through the previously opened service request or GitHub discussion. This will allow them to proceed with the removal of the old item and its related configurations (repositories, pipelines, etc.) from the publicly accessible Marketplace.
Once the repository configuration is complete, the final operational step involves creating the Item Configuration following the [guide for creating Marketplace items](/marketplace/add_to_marketplace/create_your_company_marketplace.md). At this point, it's essential to notify the Mia-Platform maintenance team of the completion of the preceding steps, either through the previously opened service request or GitHub discussion. This will allow them to proceed with the removal of the old item and its related configurations (repositories, pipelines, etc.) from the publicly accessible Marketplace.

## Porting an existing item to the Public Marketplace

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: contributing_overview
id: create_your_company_marketplace
title: Create your Company Marketplace
sidebar_label: Company Marketplace
---
Expand Down Expand Up @@ -88,8 +88,8 @@ Here below are listed all the properties that must be provided for each type of
- **`itemId`** (required): the ID identifying the item in the Marketplace
- **`description`**: a brief description (10 to 20 words) regarding the service functionalities
- **`type`**: the type of your item (plugin, template, example, application, or proxy)
- **`comingSoon`** and **`releaseStage`**: properties to identify the maturity of the item (learn how to configure them in a [dedicated section](/marketplace/add_to_marketplace/contributing_overview.md#the-release-stage-of-a-new-item) later on this page)
- **`categoryId`**: a label to help categorize items by their purpose or use case. As specified before, categories are only created internally at Mia-Platform. The `categoryId` of a item uniquely specifies both the specific category and sub-category (e.g. Start from Code (category) - Node.js (subcategory) will be identified by the `categoryId` "nodejs"). The [available category IDs](/marketplace/add_to_marketplace/contributing_overview.md#category-list) are listed below.
- **`comingSoon`** and **`releaseStage`**: properties to identify the maturity of the item (learn how to configure them in a [dedicated section](/marketplace/add_to_marketplace/create_your_company_marketplace.md#the-release-stage-of-a-new-item) later on this page)
- **`categoryId`**: a label to help categorize items by their purpose or use case. As specified before, categories are only created internally at Mia-Platform. The `categoryId` of a item uniquely specifies both the specific category and sub-category (e.g. Start from Code (category) - Node.js (subcategory) will be identified by the `categoryId` "nodejs"). The [available category IDs](/marketplace/add_to_marketplace/create_your_company_marketplace.md#category-list) are listed below.
- **`supportedBy`**: a label to identify the company that has produced the item (only used if `supportedByImage` is not provided)
- **`imageUrl`** and **`supportedByImageUrl`**: respectively the image that will be associated with the item and the image that will be associated with the company that has produced it.
- **`version`**: the version of the item. It is an object composed by the following properties:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ You have developed a new service (for example a NodeJS service)
called "My Awesome Service". The service is a plugin, i.e. users are only required to configure it and deploy it in their project.
You now want it to be available in the Marketplace of your Company.

First of all, you need to create a JSON file as explained in [this guide](/marketplace/add_to_marketplace/contributing_overview.md#how-to-configure-a-new-component).
First of all, you need to create a JSON file as explained in [this guide](/marketplace/add_to_marketplace/create_your_company_marketplace.md#how-to-configure-a-new-item).
Save the file, for example as `myAwesomeService.json` file.

The file contents will look like this:
Expand Down Expand Up @@ -339,4 +339,4 @@ If you want, you can recreate the item on the Marketplace again by applying the
## Open an issue on Mia-Platform Github community page

To contribute to the Mia-Platform Marketplace using this method, start by opening an issue [here](https://github.com/mia-platform/community/issues/new?assignees=%40mia-platform%2Fsig-marketplace&labels=marketplace&projects=&template=marketplace-contribution.yaml&title=%5BNew+marketplace+item%5D%3A+). This issue will outline the necessary information for your request.
Subsequently, a Mia-Platform representative will take over the issue and contact you to collaboratively plan the addition of the component to the Mia-Platform Marketplace, following the guidelines described on [this documentation page](/marketplace/add_to_marketplace/contributing_overview.md).
Subsequently, a Mia-Platform representative will take over the issue and contact you to collaboratively plan the addition of the component to the Mia-Platform Marketplace, following the guidelines described on [this documentation page](/marketplace/add_to_marketplace/create_your_company_marketplace.md).
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Both methods will be explained in the following paragraphs.

### Accessibility to other Companies

To make a Marketplace item of your Company accessible to other Companies, you first need to create it. Follow the instructions on [this page](/marketplace/add_to_marketplace/contributing_overview.md#how-to-configure-a-new-component) to do so.
To make a Marketplace item of your Company accessible to other Companies, you first need to create it. Follow the instructions on [this page](/marketplace/add_to_marketplace/create_your_company_marketplace.md#how-to-configure-a-new-item) to do so.

When creating your Marketplace item, you can make it accessible to other companies by editing its `visibility` property. Specifically, set the `allTenants` property inside the `visibility` object to "true".
After editing, the visibility property should look like this:
Expand Down
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 [Contributing Overview](/marketplace/add_to_marketplace/contributing_overview.md) for further information.
If you want to create your own example, head to the [Create your Company Marketplace](/marketplace/add_to_marketplace/create_your_company_marketplace.md) page for further information.
2 changes: 1 addition & 1 deletion docs/marketplace/overview_marketplace.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ The results of your search will always appear organized by Category.

:::info

You can contribute to the Mia-Platform Marketplace by creating and sharing your own items. Find out more about how to [contribute to the Marketplace](/marketplace/add_to_marketplace/contributing_overview.md).
You can contribute to the Mia-Platform Marketplace by creating and sharing your own items. Find out more about how to [create your Company Marketplace](/marketplace/add_to_marketplace/create_your_company_marketplace.md).

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/marketplace/templates/mia_templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ Mia-Platforms currently supports the following examples:

You can also [build a template](/marketplace/add_to_marketplace/add_item_by_type/add_template_or_example.md) by yourself.

Head to the [Contributing Overview](/marketplace/add_to_marketplace/contributing_overview.md) for further information on how to create and upload it to the Marketplace.
Head to the [Create your Company Marketplace](/marketplace/add_to_marketplace/create_your_company_marketplace.md) page for further information on how to create and upload it to the Marketplace.
2 changes: 1 addition & 1 deletion sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -1639,7 +1639,7 @@
"label": "Create your Company Marketplace",
"type": "category",
"link": {
"id": "marketplace/add_to_marketplace/contributing_overview",
"id": "marketplace/add_to_marketplace/create_your_company_marketplace",
"type": "doc"

},
Expand Down

0 comments on commit d13d93b

Please sign in to comment.