search

amplication / docs

Amplication docs
https://docs.amplication.com
Apache License 2.0
17 stars 62 forks source link

Docs: Plugins Revamp #506

Closed dericksozo closed 2 months ago

dericksozo commented 4 months ago

(docs): Re-structuring the sidebar for plugins, renaming pages, and also re-writing the contents for the plugins explained page.

dericksozo commented 4 months ago

Hey @PazYanoverr, I'm also taking care of #498 on this PR.

dericksozo commented 4 months ago

The latest draft for #499 is in this PR, @PazYanoverr. Please let me know if this is alright, or I should open a separate PR going forward.

PazYanoverr commented 3 months ago

@dericksozo - A different note that may be relevant here- in https://docs.amplication.com/getting-started/plugins/ when pressing develop your own custom plugins, a weird page which is not part of the documentation is opened.

dericksozo commented 3 months ago

I appreciate the feedback, @PazYanoverr. I'll look into this one and push a fix.

dericksozo commented 3 months ago

@PazYanoverr, the latest commit implements your feedback for this PR. PR #508 fixes a few things too so can it be merged first?

  1. Regarding the broken develop your own custom plugins sidebar link, I fixed it in #508.
  2. Regarding the plugin list, I updated it in #508 so we can keep it if that's alright with you.
  3. In terms of fleshing out the authentication guide a bit more, I will update this one again in the next commit with more examples.
dericksozo commented 3 months ago

I appreciate the feedback, @PazYanoverr. I just implemented it.

dericksozo commented 3 months ago

@PazYanoverr, I implemented your feedback. I also added a new <Tabs> component to separate out the instructions for Node.js and .NET. We can start using this more throughout the docs. What are your thoughts?

PazYanoverr commented 2 months ago

@dericksozo - Reviewed and added two more comments. I liked the component, and, moving forward, we can certainly use it in more places as well. I found one issue with this component- it's not clear where the component "ends", i.e. which parts/section is influenced by the tab changes. Can it be handled easily?

dericksozo commented 2 months ago

Hey @PazYanoverr, I implemented your feedback. I styled the tabs component a bit and it looks like this. Is that alright?

Screen Shot 2024-09-02 at 4 45 40 PM

Next, how can I check for the provided users on the service dashboard?

PazYanoverr commented 2 months ago

Thanks @dericksozo. The new component looks great!

PazYanoverr commented 2 months ago

@dericksozo -regarding the users- The seed script of the generated code contains the first user details. The generated README file of the Node.js contains it as well- .NET example (generated code)- image

Node.js example (generated code)- image

Generated README file in Node.js- image

Generally speaking- we can say that for Node.js a default user of admin/admin is created, and in .NET - test@email.com / P@ssw0rd!

In addition- the above info appears in the plugin settings and the user can set it before generating the code.

Hope it makes sense

dericksozo commented 2 months ago

The feedback is implemented for this one, @PazYanoverr. I cleaned it up a bit!