Skip to content
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.

Sign up for GitHub

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

Jump to bottom

feat: update Extensions tutorial to include support to outbound calls #1879

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open

feat: update Extensions tutorial to include support to outbound calls #1879

wants to merge 14 commits into from

Conversation

ThisIsDemetrio
Copy link
Contributor

Description

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

Other information

@ThisIsDemetrio ThisIsDemetrio requested a review from a team as a code owner January 2, 2025 17:16
ThisIsDemetrio
ThisIsDemetrio commented Jan 2, 2025
View reviewed changes
docs/console/tutorials/create-extension.md Outdated

You are going to customize the sidebar of a Mia-Platform project by adding a new menu and a new link that, when clicked, will show an integrated Composer page.
<!-- TODO: Should the Integration Connector Agent be part of the official Docs? Why can't I find it? -->
This page will include a table with data extracted from an API coming from another project that uses the [Integration Connector Agent](https://github.com/mia-platform/integration-connector-agent/blob/main/docs/10_overview.md) to connect to a [Jira](https://www.atlassian.com/software/jira) Data Source.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Should the Integration Connector Agent be part of the official Docs? Because I can't find it!

ThisIsDemetrio
ThisIsDemetrio commented Jan 2, 2025
View reviewed changes
docs/console/tutorials/create-extension.md Outdated
### 4. Update the Composer page

<!-- TODO: How do I add the CRUD Client using the UI? -->
Now that we can finally connect to the API, it is finally time to update the Composer page to include the [CRUD Client component](/microfrontend-composer/back-kit/60_components/100_crud_client.md) to allow the table to fetch the data to show.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Is there any way to configure the CRUD Client with the UI?

marcofilippi
marcofilippi reviewed Jan 8, 2025
View reviewed changes
docs/console/tutorials/create-extension.md Outdated

Following this tutorial you will learn how to add the Backoffice as an extension within a Project, in order to consult it directly from the Console.
And to do so, you will be using to create using only [miactl](/cli/miactl/10_overview.md), the command line interface application to communicate with the Mia-Platform Console APIs.
Copy link
Contributor

Choose a reason for hiding this comment

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

it is not very clear what this refers to

Copy link
Member

Choose a reason for hiding this comment

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

it seems like the entire tutorial is only about miactl, whereas we actually show the first part without miactl.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I forgot a part. The tutorial has been changed from "creating an extension with miactl" to "create an extension, and then explaining how to use miactl for some operations". I'm going to rephrase this.

akelity
akelity requested changes Jan 8, 2025
View reviewed changes
Copy link
Member

@akelity akelity left a comment

Choose a reason for hiding this comment

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

I’ve added some comments, some are minor details, while others in my opinion should be addressed before publication.

akelity
akelity approved these changes Jan 9, 2025
View reviewed changes
Copy link
Member

@akelity akelity left a comment

Choose a reason for hiding this comment

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

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@marcofilippi marcofilippi marcofilippi left review comments

@akelity akelity akelity approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ThisIsDemetrio @akelity @marcofilippi