update README ahead of UI one-click zero-config install #50
Conversation
lindsaylevine
requested review from
cassidoo,
verythorough,
ehmicky and
rstavchansky
lindsaylevine
added
the
type: chore
There was a problem hiding this comment.
@lindsaylevine I added a bunch of minor editing suggestions. Feel free to accept or not.
Looks good!
README.md
Outdated
| package = "@netlify/plugin-nextjs" | ||
| ``` | ||
|
|
||
| This plugin can also be installed and managed from your site's settings on Netlify. |
There was a problem hiding this comment.
I'm curious from @verythorough's POV whether the UI workflow is recommended over the TOML file-based workflow. If so, you may want to move this up to be the first installation option.
You can add something like this to link to the docs:
Read more about installing a plugin with the Netlify UI in our docs.
There was a problem hiding this comment.
Yeah, I lean towards pitching the UI install first. We could start the installation section to say that the plugin can run with no configuration, and then present a link, probably in a text block or something to give it more attention, e.g.
I went a little goofy, but you get the idea. 😛 (Incidentally, I'm now going to file an issue for an "Install this plugin" button.)
For the link, after https://github.com/netlify/netlify-react-ui/pull/6326 is merged, this link will work:
http://app.netlify.com/plugins/@netlify/plugin-nextjs/install
Until then, you can see what the experience will be like by testing this link (which is what I used in my emoji-laden example:
https://deploy-preview-6326--app.netlify.app/plugins/@netlify/plugin-nextjs/install
There was a problem hiding this comment.
ok, i am going to handle the click to install link as a fast follow, but made a change suggesting ui install first pointing to the ui-based installation part of the docs !
| This plugin can also be installed and managed from your site's settings on Netlify. | ||
| If you want to install there, you can omit this [[plugins]] section from your .toml file. | ||
|
|
||
| ## Custom Netlify Functions |
There was a problem hiding this comment.
Do we even need to mention custom Netlify Functions at all?
I am assuming if a site is using a Functions directory, they will assume this plugin to just work with it.
If a site is not using a Functions directory, then the default Functions directory will be used instead, which the user will not see.
|
|
||
| [[plugins]] | ||
| package = "@netlify/plugin-nextjs" | ||
| ``` | ||
|
|
||
| [Read more about Netlify Functions here](https://docs.netlify.com/functions/overview/). | ||
|
|
||
| ## Publish Directory |
There was a problem hiding this comment.
Same comment as for Functions directory: do we even need to mention it?
| [build] | ||
| command = "npm run build" |
README.md
Outdated
| package = "@netlify/plugin-nextjs" | ||
| ``` | ||
|
|
||
| This plugin can also be installed and managed from your site's settings on Netlify. |
There was a problem hiding this comment.
Yeah, I lean towards pitching the UI install first. We could start the installation section to say that the plugin can run with no configuration, and then present a link, probably in a text block or something to give it more attention, e.g.
I went a little goofy, but you get the idea. 😛 (Incidentally, I'm now going to file an issue for an "Install this plugin" button.)
For the link, after https://github.com/netlify/netlify-react-ui/pull/6326 is merged, this link will work:
http://app.netlify.com/plugins/@netlify/plugin-nextjs/install
Until then, you can see what the experience will be like by testing this link (which is what I used in my emoji-laden example:
https://deploy-preview-6326--app.netlify.app/plugins/@netlify/plugin-nextjs/install
lindsaylevine
force-pushed
the
ll/config-updates-readme
branch
from
ab154a1 to
a5f8c6c
Compare
lindsaylevine
force-pushed
the
ll/config-updates-readme
branch
from
a5f8c6c to
247c0f2
Compare
* feat: proxying res obj * check blob for cachetag * add cache-tags to pages/app * added types * removed hard coded deploy ID * removed extra comma * fix tag format for purge and add manifest * refactoring * add pageData var * updated setcacheheaders logic * initial testing for cache-tags * updated unit test page data * cache-tags integration tests for app * page router tests * integration test for pages revalidate * lock file * chore: fix tests * chore: update tests * feat: readd missing mockRequestHandlers * chore: fix tests --------- Co-authored-by: Rob Stanford <[email protected]>
Fixes #44
this will definitely be a work in progress over the next day. please comment/suggest whatever.