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: Plugins Revamp #506

Merged
merged 22 commits into from
Sep 19, 2024
Merged

Docs: Plugins Revamp #506

merged 22 commits into from
Sep 19, 2024

Conversation

dericksozo
Copy link
Contributor

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

…lso re-writing the contents for the plugins explained page.
@dericksozo dericksozo added the documentation Improvements or additions to documentation label Jul 18, 2024
@dericksozo dericksozo self-assigned this Jul 18, 2024
@dericksozo
Copy link
Contributor Author

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

@dericksozo
Copy link
Contributor Author

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
Copy link
Member

@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
Copy link
Contributor Author

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

docs/getting-started/plugins.md Outdated Show resolved Hide resolved
docs/getting-started/plugins.md Outdated Show resolved Hide resolved
docs/getting-started/plugins.md Outdated Show resolved Hide resolved
docs/getting-started/plugins.md Outdated Show resolved Hide resolved
docs/getting-started/plugins.md Show resolved Hide resolved
docs/how-to/choose-configure-update-database.md Outdated Show resolved Hide resolved
docs/how-to/choose-configure-update-database.md Outdated Show resolved Hide resolved
docs/how-to/choose-configure-update-database.md Outdated Show resolved Hide resolved
@dericksozo
Copy link
Contributor Author

@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 Docs: .NET Plugins + .NET Plugin Event Reference #508.
  2. Regarding the plugin list, I updated it in Docs: .NET Plugins + .NET Plugin Event Reference #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.

docs/how-to/authentication-plugin-examples.md Outdated Show resolved Hide resolved
docs/how-to/authentication-plugin-examples.md Outdated Show resolved Hide resolved
docs/how-to/authentication-plugin-examples.md Outdated Show resolved Hide resolved
docs/how-to/authentication-plugin-examples.md Outdated Show resolved Hide resolved
docs/how-to/authentication-plugin-examples.md Outdated Show resolved Hide resolved
…ng info about categories. 2. Adding more examples in the authentication plugin guide. Updating a screenshot. Implementing Paz's feedback.
docs/how-to/authentication-plugin-examples.md Outdated Show resolved Hide resolved
docs/how-to/authentication-plugin-examples.md Outdated Show resolved Hide resolved
docs/how-to/authentication-plugin-examples.md Outdated Show resolved Hide resolved
docs/how-to/authentication-plugin-examples.md Outdated Show resolved Hide resolved
docs/how-to/authentication-plugin-examples.md Outdated Show resolved Hide resolved
docs/how-to/authentication-plugin-examples.md Outdated Show resolved Hide resolved
docs/how-to/authentication-plugin-examples.md Outdated Show resolved Hide resolved
docs/how-to/authentication-plugin-examples.md Outdated Show resolved Hide resolved
@dericksozo
Copy link
Contributor Author

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

docs/how-to/authentication-plugin-examples.md Outdated Show resolved Hide resolved
docs/how-to/authentication-plugin-examples.md Outdated Show resolved Hide resolved
docs/how-to/authentication-plugin-examples.md Outdated Show resolved Hide resolved
@dericksozo
Copy link
Contributor Author

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

…ouping the tabs together. If we add another tab they'll be synced.
@PazYanoverr
Copy link
Member

@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
Copy link
Contributor Author

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
Copy link
Member

Thanks @dericksozo.
The new component looks great!

@PazYanoverr
Copy link
Member

@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
Copy link
Contributor Author

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

@PazYanoverr PazYanoverr merged commit 1b29b37 into main Sep 19, 2024
5 checks passed
@PazYanoverr PazYanoverr deleted the docs/plugins-revamp branch September 19, 2024 06:25
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