search

amplication / docs

Amplication docs
https://docs.amplication.com
Apache License 2.0
16 stars 57 forks source link

Write Plugin-focused How To Guides #495

Open dericksozo opened 1 month ago

dericksozo commented 1 month ago

Instead of generic tech descriptions for the technology a plugin uses, let's create in-depth guides on common user tasks that need plugins? Things like changing databases, tweaking authentication, etc.

dericksozo commented 1 month ago

@PazYanoverr, do we have any data from users, the community, or elsewhere about the top 3 most common use cases related to plugins? Is it updating a database, changing authentication, deploying, or something else?

dericksozo commented 1 month ago

Image

Hey @PazYanoverr, these are the top installed plugins for the past 30 days according to PostHog. Given that data, here are some of the guides I think we should create.

  1. How To Configure and Use PostgresSQL
  2. How To Update Your Database
  3. How To Update Your Authentication Setup
  4. How To Integrate and Manage a Message Broker

What are your thoughts?

PazYanoverr commented 1 month ago

@dericksozo - Sounds good!

  1. I think that we should unite the first guide and the second. Postgres is the default DB, and therefore, I believe it's the most commonly used. So- I think the article should be about choosing and updating the db.
  2. Regarding the auth setup- again- I think the article should be about configuring (i.e. for a service without auth) and updating
  3. Maybe we should add more articles- about (1) Redis (cache)- use case + how to + settings, (2) open ai - use case + how to + settings, and (3) something about deployment (- maybe here we just need a link to the deployment new section or such)
dericksozo commented 1 month ago

Thanks for the feedback, @PazYanoverr. Here are the titles I've brainstormed for the guides:

  1. How To Choose, Configure, and Update Your Database
  2. How To Configure and Update Your Authentication Setup
  3. How To Integrate and Manage a Message Broker
  4. How To Implement and Configure Redis Caching
  5. How To Integrate OpenAI's APIs with Amplication
  6. How to Deploy Amplication Apps to Different Cloud Providers

If these look good to you I can go in and create individual issues in the GitHub board for these.

PazYanoverr commented 1 month ago

@dericksozo - Sounds good. A few comments:

  1. In # 2- let's talk about authentication and authorization.
  2. In # 4 and # 5 - let's have more "general" topics- "How To Implement and Configure Caching", "How To Integrate AI in your backend services"
  3. Regarding priorities- I would say # 1 --> # 2 --> # 3 --> # 6 --> #5 --> # 4