Add build instructions for JS, too

codidact · Jun 1, 2020 · 67fb9bb · 67fb9bb
1 parent 02cc65a
commit 67fb9bb
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 4 deletions.
diff --git a/docs/setup/improving/index.html b/docs/setup/improving/index.html
@@ -216,13 +216,16 @@ <h2>What's the workflow?</h2>
 so please fix the failures and commit again. You can always
 mark your pull request as <em>Draft Pull Request</em>
 while you're still trying to make it work.</p>
-<h2>How to build the CSS and the documentation?</h2>
+<h2>How to build the CSS, the JS and the documentation?</h2>
 <p>First of all, you need to make sure, that you have everything important installed. Run this command to set up the development environment:</p>
 <pre><code>$ npm install
 </code></pre>
 <p>To build the CSS you need to run:</p>
 <pre><code>$ npm run build
 </code></pre>
+<p>To build the JS you need to run:</p>
+<pre><code>$ npm run js_build
+</code></pre>
 <p>To build the documentation you need to run:</p>
 <pre><code>$ npx @11ty/eleventy
 </code></pre>

diff --git a/docs/setup/releasing/index.html b/docs/setup/releasing/index.html
@@ -180,7 +180,7 @@ <h1>Releasing Co-Design</h1>
                 <p>Follow this guide to release a new version of Co-Design:</p>
 <ol>
 <li>
-<p>Open the repository in your terminal and <a href="/setup/improving">build both the css and the documentation</a>. There shouldn't be any changes in the most cases, but if there are any, commit them.</p>
+<p>Open the repository in your terminal and <a href="/setup/improving">build the css, the js and the documentation</a>. There shouldn't be any changes in the most cases, but if there are any, commit them.</p>
 </li>
 <li>
 <p>Now run <code>npm version x.y.z</code>. This will update the package json files and create a new commit with that version name.</p>

diff --git a/docs_src/setup/improving.md b/docs_src/setup/improving.md
@@ -46,7 +46,7 @@ so please fix the failures and commit again. You can always
 mark your pull request as *Draft Pull Request*
 while you're still trying to make it work.
 
-## How to build the CSS and the documentation?
+## How to build the CSS, the JS and the documentation?
 
 First of all, you need to make sure, that you have everything important installed. Run this command to set up the development environment:
 
@@ -60,6 +60,12 @@ To build the CSS you need to run:
 $ npm run build
 ```
 
+To build the JS you need to run:
+
+```
+$ npm run js_build
+```
+
 To build the documentation you need to run:
 
 ```

diff --git a/docs_src/setup/releasing.md b/docs_src/setup/releasing.md
@@ -6,7 +6,7 @@ description: This instructions will guide you how to release a new version Co-De
 
 Follow this guide to release a new version of Co-Design:
 
-1. Open the repository in your terminal and [build both the css and the documentation](/setup/improving). There shouldn't be any changes in the most cases, but if there are any, commit them.
+1. Open the repository in your terminal and [build the css, the js and the documentation](/setup/improving). There shouldn't be any changes in the most cases, but if there are any, commit them.
 2. Now run `npm version x.y.z`. This will update the package json files and create a new commit with that version name.
 
     Choose x, y and z based on our current release version and on the amount of changes this release introduces. As a general rule, you'll probably never increment x, you'll increment y if new components are introduced or other major changes are done and you'll increment z in all other cases. When changing y, set z to 0.