Docs: How do we version patterns on npm? #119

visual-framework · Jul 1, 2019 · 06f8caa · 06f8caa
1 parent 195316d
commit 06f8caa
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 4 deletions.
diff --git a/components/vf-badge/vf-badge.config.yml b/components/vf-badge/vf-badge.config.yml
@@ -21,8 +21,8 @@ variants:
     context:
       text: alpha
       theme: tertiary
-      override_class: "Hey--Ken"
-      id: "Yo-Ken"
+      override_class: "your-extra-class"
+      id: "your-id"
   - name: outline
     context:
       text: alpha

diff --git a/docs/changelog/index.njk b/docs/changelog/index.njk
@@ -33,6 +33,8 @@ We support the last two minor releases with bug fixes and branding. New features
 
 Where's version 1.x, you ask? That's the [EMBL-EBI specific Visual Framework](https://github.com/ebiwd/EBI-Framework) from where this concept [originated, and evolved](https://blogs.embl.org/communications/2018/09/12/faster-scientific-websites-through-reusability/).
 
+<span class="vf-badge vf-badge--tertiary">Related</span> [Notes on component versioning]({{ '/docs/contributing/updating-a-component' | path }}).
+
 ### Test releases
 
 Testing releases will be identified in their tag, a la: `v2.0-alpha.1`, where `-alpha.1` is the tag. `-alpha`, `-beta` and `-rc` are tag suffixes.
diff --git a/docs/contributing/creating-new-components.njk b/docs/contributing/creating-new-components.njk
@@ -1,6 +1,6 @@
 ---
 title: Creating a new component
-order: 200
+order: 201
 isIndex: false
 ---
 

diff --git a/docs/contributing/deprecating-components.njk b/docs/contributing/deprecating-components.njk
@@ -1,6 +1,6 @@
 ---
 title: Deprecating components
-order: 205
+order: 203
 isIndex: false
 ---
 

diff --git a/docs/contributing/updating-a-component.njk b/docs/contributing/updating-a-component.njk
@@ -0,0 +1,15 @@
+---
+title: Versioning and updating a component
+order: 202
+isIndex: false
+---
+
+Like the Visual Framework 2.0, components follow [semantic versioning](https://semver.org/) by increasing their full version number every time they have breaking changes.
+
+However the version number of components its not tied to the version number of the Visual Framework's `vf-core`; that is: the `vf-core@2.1.2` might use `vf-button@1.0.1` and `vf-component-x@8.2.1`.
+
+As such components should specify if they only support specific versions of `vf-core` or require other specific versions of patterns.
+
+You can read more about [component versioning in this issue](https://github.com/visual-framework/vf-core/issues/119).
+
+<span class="vf-badge vf-badge--tertiary">Related</span> [Notes on the VF versioning]({{ '/docs/changelog#versioning' | path }}).