docs icon indicating copy to clipboard operation
docs copied to clipboard

Docs: Plugins Revamp

Open dericksozo opened this issue 1 year ago • 7 comments

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

dericksozo avatar Jul 18 '24 04:07 dericksozo

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

dericksozo avatar Jul 24 '24 07:07 dericksozo

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.

dericksozo avatar Jul 25 '24 04:07 dericksozo

@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.

PazYanoverr avatar Jul 30 '24 09:07 PazYanoverr

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

dericksozo avatar Jul 30 '24 11:07 dericksozo

@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 avatar Jul 31 '24 10:07 dericksozo

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

dericksozo avatar Aug 20 '24 07:08 dericksozo

@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?

dericksozo avatar Aug 22 '24 05:08 dericksozo

@dericksozo - Reviewed and added two more comments. I liked the <Tabs> 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?

PazYanoverr avatar Aug 25 '24 09:08 PazYanoverr

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?

dericksozo avatar Sep 02 '24 09:09 dericksozo

Thanks @dericksozo. The new component looks great!

PazYanoverr avatar Sep 16 '24 05:09 PazYanoverr

@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 - [email protected] / 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

PazYanoverr avatar Sep 16 '24 08:09 PazYanoverr

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

dericksozo avatar Sep 17 '24 12:09 dericksozo