Docs: Service Catalog #526
Conversation
…or a new Services Dashboard page.
docs/how-to/services-dashboard.md
Outdated
| @@ -0,0 +1,76 @@ | |||
| --- | |||
| title: Services Dashboard | |||
There was a problem hiding this comment.
Let's call it Service Catalog
docs/how-to/services-dashboard.md
Outdated
| --- | ||
| title: Services Dashboard | ||
| description: Learn about Amplication's Services Dashboard, including service management, views, and related features. | ||
| sidebar_label: Services Dashboard |
docs/how-to/services-dashboard.md
Outdated
| slug: /services-dashboard | ||
| --- | ||
|
|
||
| The **Services Dashboard** is a central feature in Amplication that allows you to manage and oversee all the services within your projects. This dashboard provides a comprehensive view of your services, their statuses, and quick access to various management tools. |
There was a problem hiding this comment.
Let's use Catalog instead of Dashboard (- in the other places as well).
Moreover- "Service catalog" is one of the major capabilities required in IDP solutions (- internal developer portals). Let's use the IDP terminology in this doc and in the documentation as a whole.
docs/how-to/services-dashboard.md
Outdated
|
|
||
| The Services Dashboard offers two main views for managing your services: | ||
|
|
||
| 1. **Cards View**: The default view, presenting services as individual cards with basic information. |
There was a problem hiding this comment.
Let's avoid discussing the default view- as it may change (- to grid)
docs/how-to/services-dashboard.md
Outdated
| The Services Dashboard offers two main views for managing your services: | ||
|
|
||
| 1. **Cards View**: The default view, presenting services as individual cards with basic information. | ||
| 2. **Grid View**: A compact, data-rich view providing detailed information about each service. |
There was a problem hiding this comment.
Let's start with this view and only then mention the cards view
docs/how-to/services-dashboard.md
Outdated
|
|
||
| ## Cards View | ||
|
|
||
| The Cards View is the default view of the Services Dashboard. Each service is represented by a card that displays: |
There was a problem hiding this comment.
Let's omit the "default" part
docs/how-to/services-dashboard.md
Outdated
|
|
||
| The Grid View offers a more compact and information-rich display of your services. To switch to Grid View, click the toggle next to the search bar to change from Card View to Grid View. | ||
|
|
||
| In Grid View, you can see: |
There was a problem hiding this comment.
Again- need to update as things were changed here :)
docs/how-to/services-dashboard.md
Outdated
| - Entity changes | ||
| - Service setting modifications | ||
|
|
||
| After reviewing the pending changes, you can click the "Generate Code" button to commit these changes to the associated repository. To view the build process and results, you can access the [Build View](/building-new-versions/). |
There was a problem hiding this comment.
BTW- the default behavior for the "Generate the code" button is to build the services that have pending changes. Let's update it in the relevant place/s
docs/how-to/services-dashboard.md
Outdated
|
|
||
| ## Next Steps | ||
|
|
||
| Now that you understand how the Services Dashboard is organized and everything it is capable of, you can start diving into your services to make all the necessary changes and additions. Explore each service, utilize the different views, and take advantage of the various management tools available to streamline your development process. |
There was a problem hiding this comment.
I guess we need to discuss here the live templates, private plugins, and such
docs/how-to/services-dashboard.md
Outdated
|
|
||
| From this dashboard, you can access all the essential parts of your service management, including sync with Git, settings, architecture view, and more. | ||
|
|
||
|  |
There was a problem hiding this comment.
All the screenshots in this PR should be updated to reflect the new status
(docs): Adding the new page, sidebar link, content, and screenshots for a new Services Dashboard page.
This PR takes care of #522.