Update docs about adding template #1674
Conversation
|
Bless your heart! @lbogdan any stack trace for this fail? |
contributor-docs/adding-template.md
Outdated
| Unlike sandboxes, **containers** are executed on a server. This makes it possible to create projects that are end-to-end based, like `Next.js` with CodeSandbox, and also makes it possible to build bigger projects. **Containers** let you run any command, and everything that works locally will also work in container. | ||
|
|
||
| There are some limitations to this approach though: we only allow signed in users to work on a container and the amount of container sandboxes a user can have is limited (this limit changes as we make containers more stable). You also can't edit containers while offline and it's not possible to edit containers when viewing from an embed. | ||
| However, like the sandboxes, **containers** also come with some limitations. In order to work on a container, you need to be signed in as a user, you can't edit containers while offline, it's not possible viewing them from an embed, and ~~you can only have a limited amount of container based projects~~ ([containers are now out of beta](https://medium.com/@compuives/codesandbox-containers-out-of-beta-improvements-be79679df4cc)). |
There was a problem hiding this comment.
Containers are out of beta but we still have a limited amount a user can have :/
There was a problem hiding this comment.
What @SaraVieira said, we should drop the strike-through to not mislead people. As a side-note, client sandboxes are also limited for regular users, only the limit is higher (50 vs. 15).
contributor-docs/adding-template.md
Outdated
| The template defines whether a sandbox is executed in a container or in the browser. This means that it's your choice where to execute the sandbox. | ||
| As you have read above, the template type determines whether a project is executed in a *sandbox in a browser* or in a *container on a server*. This means that the template type you have to choose, depends on your specific use-case and where you want your project to be executed. | ||
|
|
||
| If you would like to demonstrate CLI functionality, we recommend that you use a **container** type template, and if you want to demonstrate a JavaScript framework (like `create-react-app`) we recommended using a**sandbox** type template. |
There was a problem hiding this comment.
| If you would like to demonstrate CLI functionality, we recommend that you use a **container** type template, and if you want to demonstrate a JavaScript framework (like `create-react-app`) we recommended using a**sandbox** type template. | |
| If you would like to demonstrate CLI functionality, we recommend that you use a **container** type template, and if you want to demonstrate a JavaScript framework (like `React`) we recommended using a**sandbox** type template. |
Create React App is the CLI, maybe makes sense for this to be react
Co-Authored-By: vicbergquist <[email protected]>
|
Hey @vicbergquist , Great stuff right here, thanks for your effort! I left a few tiny suggestions. Also, I'm a bit on the fence regarding terminology - sandbox / client sandbox / browser sandbox / container sandbox / server sandbox - which has been going on since we launched containers, so this might be a good opportunity to settle this once and for all! 🙂 |
Co-Authored-By: vicbergquist <[email protected]>
Co-Authored-By: vicbergquist <[email protected]>
thank you! Yes, it is so confusing :/ |
Co-Authored-By: vicbergquist <[email protected]>
Co-Authored-By: vicbergquist <[email protected]>
CompuIves
left a comment
CompuIves
left a comment
There was a problem hiding this comment.
Wow, this is really good @vicbergquist. Thank you so much for this! I left two comments, one about some small typos and one about the embed viewing. I also saw some TODOs, but I think that it's no problem to merge these changes already if you're okay with it.
Thanks again, this is really helpful!
Co-Authored-By: vicbergquist <[email protected]>
Co-Authored-By: vicbergquist <[email protected]>
Thank you, happy I can be of help! If you're happy with the current way it's written and the fixes, please do merge it if you'd like! 😃 |
|
Great! This is already a huge improvement, thank you for this! |
4 participants
What kind of change does this PR introduce?
Added more info about creating a template and the steps involved.
What is the current behavior?
Noticed when I created a template that clearer docs would be nice.
What is the new behavior?
More info about creating a template.
Checklist:
I might have missed something or not explained something properly/in the wrong way, so would love some feedback.