-
Notifications
You must be signed in to change notification settings - Fork 87
docs(recipes): update module deployment recipe #300
Conversation
📊 Bundle Size Report
|
docs/recipes/Deploying-Modules.md
Outdated
|
||
[Now.sh](https://zeit.co/home) allows you to deploy statics such as your modules. We will accomplish this by using [GitHub Actions](https://github.com/features/actions). | ||
1. Upload the contents of the `build` folder to your CDN of choice. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thoughts on calling this, publishing a module. and adding ad note "uploading to the CDN publishes/releases, similar to how you release a dependency. Updating a module map will tell one-app to consume that published/released module version."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i agree on this, and create separate documentation on how to do this and a step by step on uploading to a cdn/using actions to achieve this
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@JAdshead do you mean changing the name of the entire guide to be "Publising modules" or is this just for the "deployment overview" section?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Renamed to Publishing modules
docs/recipes/Deploying-Modules.md
Outdated
|
||
[Now.sh](https://zeit.co/home) allows you to deploy statics such as your modules. We will accomplish this by using [GitHub Actions](https://github.com/features/actions). | ||
1. Upload the contents of the `build` folder to your CDN of choice. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should we also recommend uploading the contents of a build folder to a folder matching the name of the module:
/module-name/[contents-of-build-including-version]
| -module-name
└ [version]
├ [locale]
| └ *.locales
├ module-name.browser.js
├ module-name.legacy.browser.js
├ module-name.node.js
└ ..
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think I used to have that structure in my original script, but guess for Vercel was removed because it looks like you can't upload more than 1 module to the same project/url and you cannot select a folder, so every module will have it's own CDN instance / url which is a pain. With Amazon S3 you can keep all your modules under the same url/project so it the folder is required there
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added a note that vercel doesn't support multiple folders
docs/recipes/Publishing-Modules.md
Outdated
# Publishing Modules | ||
|
||
## 📖 Table of Contents | ||
* [Overview](overview) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* [Overview](overview) | |
* [Overview](#overview) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
added here 5423708
5423708
Updating documentation to use the new Vercel-cli and explain in more detail how the deployment of modules should work
Description
Motivation and Context
How Has This Been Tested?
Types of Changes
Checklist:
What is the Impact to Developers Using One App?