search

arielsalminen / vue-design-system

An open source tool for building UI Design Systems with Vue.js
https://vueds.com
MIT License
2.17k stars 224 forks source link

Request for Documentation: Best practices for upgrading #132

Open sdellis opened 5 years ago

sdellis commented 5 years ago

Perhaps this is clear to others, but I'm not sure I understand how to use VueDS as the basis for my own customized design system while simultaneously making it easy to keep it up to date with VueDS releases.

To provide an example, I have a system which contains many custom tokens, doc pages, and components, some of which use plugins and features that VueDS does not implement out of the box (such as vuex).

My upgrade process is to:

  1. clone the current version of VueDS
  2. drop my custom components, tokens, and doc pages into the new version
  3. manually inspect for any config changes that may have occurred and update them
  4. after I am sure it's working, I copy any changed files over to my customized system repository and again spin it up to see if I can get it to run without errors

Am I doing it wrong? Is there an easier way? Ideally, I would love to simply be able to update a vue-design-system dependency in a package.json for my custom system.

Thanks in advance for any info or suggestions!

arielsalminen commented 5 years ago

@sdellis The plan of this branch is to make this whole process much easier: https://github.com/viljamis/vue-design-system/pull/127