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

Add an FAQ article about project upgrades #146

Open
Pavel910 opened this issue Jun 19, 2020 · 1 comment
Open

Add an FAQ article about project upgrades #146

Pavel910 opened this issue Jun 19, 2020 · 1 comment
Assignees

Comments

@Pavel910
Copy link
Collaborator

This should also be linked in the Introduction article as this is a sensitive topic. Clearing this up at the very beginning will make our users more confident in the platform.

Summary of the article

Project/config structure may change over time, especially at this early stage of the platform. As we grow, learn, collect feedback, project changes are inevitable. The way we approach project upgrades is by always shipping a tool with the release that introduces any changes to the project structure (folders, config files, package.json contents, etc.).

An example of such a gist can be seen here: https://gist.github.com/Pavel910/486a5c81175c60c5a0226b4363727fff

This way we can introduce changes to the project, without releasing a major version of the entire platform. In most cases the changes are small tweaks to config files, cli plugins, etc. which are defined in your project and can not be updated by simply upgrading your npm dependencies.

By using our upgrade tool, we will upgrade your project for you, modify the necessary files, install new dependencies, etc. without you doing a single thing.The upgrade tool is a public gist so you can see exactly what will be done during the upgrade, and even create your own gist and modify it's behavior.

@Pavel910 Pavel910 self-assigned this Jun 19, 2020
@ng29
Copy link
Contributor

ng29 commented Oct 13, 2020

Hey @Pavel910

Can i work on this ?? ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants