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.

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

Docs: Platform Console #525

Merged
merged 8 commits into from
Sep 24, 2024
Merged

Docs: Platform Console #525

merged 8 commits into from
Sep 24, 2024

Conversation

dericksozo
Copy link
Contributor

(docs): Creating the inital developer documentation page for Amplication.com's new Platform Console.

@dericksozo dericksozo added the documentation Improvements or additions to documentation label Sep 24, 2024
@dericksozo dericksozo self-assigned this Sep 24, 2024
@dericksozo
Copy link
Contributor Author

Hey @PazYanoverr, I put this one under the "How To" sidebar label for now, similar to the Analytics Dashboard article. What are your thoughts on putting it here for now? The URL will always remain the same: /platform-console.

docs/how-to/platform-console.md Outdated Show resolved Hide resolved

- **Standardization**: Ensure all services follow organizational best practices and configurations.
- **Efficiency**: Quickly create new services based on pre-defined templates.
- **Centralized Management**: Update multiple services from a single location. When you update a template, all services using that template are automatically updated.
Copy link
Member

Choose a reason for hiding this comment

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

Maybe we should add smooth maintenance here?
In addition- let's update the sentence to ".... When you update a template, all services using that template can automatically get a PR with the required changes."

- **Efficiency**: Quickly create new services based on pre-defined templates.
- **Centralized Management**: Update multiple services from a single location. When you update a template, all services using that template are automatically updated.
- **Customization**: Create and use private plugins to tailor services to your organization's specific needs.

Copy link
Member

Choose a reason for hiding this comment

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

Let's also add "Omit technical debt" item or such.


1. Navigate to the Platform Console dashboard.
2. Click on "Create Template".
3. Provide a name for your template (e.g., "Node.js with PostgreSQL").
Copy link
Member

Choose a reason for hiding this comment

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

and choose the required code generator tech stack
image

Managing and updating templates is very similar to updating individual services. You have access to the same settings and options available for services, including:

- Viewing all templates in the Platform Console dashboard.
- Adding entities to the service template.
Copy link
Member

Choose a reason for hiding this comment

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

Not supported for now. Let's remove

docs/how-to/platform-console.md Outdated Show resolved Hide resolved
docs/how-to/platform-console.md Outdated Show resolved Hide resolved

1. In the Platform Console dashboard, navigate to the "Private Plugins" section.
2. Click on "Create Private Plugin".
3. Follow the creation wizard to define your plugin's functionality.
Copy link
Member

Choose a reason for hiding this comment

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

No wizard...
So-
Connect to your plugin repository, and add your existing private plugins to the project

The Platform Console feature is in beta, so we encourage you to explore its capabilities and provide feedback to help us improve and refine it.

:::tip
For any questions or issues related to the Platform Console, please [contact our support team](https://amplication.com/contact) or write your feedback on our [GitHub discussion](https://github.com/amplication/amplication/discussions/8979).
Copy link
Member

Choose a reason for hiding this comment

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

The support link is broken. Let's avoid the link here and just write "... please contact us or write your..."

docs/how-to/platform-console.md Outdated Show resolved Hide resolved
@PazYanoverr
Copy link
Member

@dericksozo - Great doc! I added a few comments.
Regarding the article "location", I would add it in two places-

image

and

image

  • instead of the Import DB link

@PazYanoverr PazYanoverr merged commit 6ad6f99 into main Sep 24, 2024
5 checks passed
@PazYanoverr PazYanoverr deleted the docs/platform-console branch September 24, 2024 10:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants