[WIP]adds Using Providers page #963
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
pwizla
added
source: Dev Docs
There was a problem hiding this comment.
Nice documentation @gpene 👏
Structure and content/explanations are clear. I added a few comments and suggestions mostly about writing style and text formatting (make sure to check our style guide if you have a doubt).
| canonicalUrl: https://docs.strapi.io/developer-docs/latest/development/using-providers.html | ||
| --- | ||
|
|
||
| # Using Providers |
There was a problem hiding this comment.
In the Developer Documentation, H1 titles usually don't follow this format. It looks a bit weird to have that one title starting with a verb.
|
|
||
| # Using Providers | ||
|
|
||
| Certain [plugins](../../../user-docs/latest/plugins/introduction-to-plugins.md) can be extended via the installation and configuration of additional [providers](../../../user-docs/latest/plugins/introduction-to-plugins.md#providers). |
There was a problem hiding this comment.
For providers I think I would add a call-to-action kind of link, instead of just adding the link like you did, so that readers are more clearly invited to go and check the user guide 🤔 Usually we use the following formatting for that: (see Providers documentation in the User Guide) (or something like that).
What do you think?
There was a problem hiding this comment.
I'm not really a fan of that style/formatting - I don't think it adds much in the way of an "invitation" to go read further than a simple inline link, and in sections with many links adds needless clutter and word count.
If we're set on that style I can change it no problem, but I don't see the value IMO?
There was a problem hiding this comment.
Thank you, Gabriel, great PR!
I have a couple of changes to suggest, but most of them were already pointed out by Mégane, so I've just added a 👍 emoji to her comments.
I have 2 more suggestions:
-
We could probably use more cross-reference links, for instance:
- when you mention plugins configuration, link to the Setup & Deployment > Configurations > Optional > Plugins section,
- when you mention environment variables, link to the corresponding documentation, etc.
I might be missing a few more (I already mentioned security middleware in a comment).
-
Since it seems like providers use some configuration options defined in
./config/plugins.js, I think that in the plugins configurations file, I'd mention providers.
Apparently, different providers have different configuration options, so we probably can't have a table like we did with plugins. But at least I'd mention something in a callout, something like:::: note The `./config/plugins.js` file can also include configuration options for providers (see [providers documentation](link to the configuration header in the providers' doc file) :::
What do you think?
|
As discussed with you, closed in favor of #992, thank you, guys! |
3 participants
What does it do?
Add page re: Using/Configuring/Developing Providers
Why is it needed?
Allows the removal (and stops duplicating) providers related content from individual Plugin pages
Related issue(s)/PR(s)
Let us know if this is related to any issue/pull request