paritytech / substrate-up

Scripts for working with new Substrate projects
Apache License 2.0
67 stars 21 forks source link

Use `substrate-package` as the primary starting point #35

Open shawntabrizi opened 4 years ago

shawntabrizi commented 4 years ago

I have not been a big fan of the substrate-up scripts for a number of reasons:

When building documentation and tutorials, we initially relied on these scripts to get users to start building, but it quickly became obvious that this pathway was not stable enough to ensure new users run into minimal issues.

This is why I created the substrate-package which is now used as the primary starting point for most of our tutorials.

The package provides branches for different scenarios:

The substrate-package provides known working and compatible-with-each-other version of:

I have seen a noticeable improvement from our users who have used the substrate-package as their starting point, and as a result I think we should make this the default pathway moving forward.

In order to make this switch, there is one fundamental requirement that we keep the package relatively up to date to what we expect to be the stable working environment. This process will just become part of the process for keeping our docs up to date. Since we want to ensure that our docs have minimal friction to new users, we will update these packages and the docs which use them together, ensuring at any point that our publicly visible development ecosystem is stable and working.

We can keep the existing scripts in spirit by simply updating them to do a git clone of the substrate-package. This would keep them truely static. I suggest in general, we put in our docs directly for the user to do git clone ... rather than running some local script. I think that this adds clarity to what is happening when a user starts a project.

shawntabrizi commented 4 years ago

I got blessing from @gavofyork on this one, so I will proceed when I find time :)