Skip to content
This repository has been archived by the owner on Nov 29, 2023. It is now read-only.

Commit

Permalink
Merge pull request #127 from yanokwa/prepare-2.0.0-docs
Browse files Browse the repository at this point in the history
Updates for 2.0.0 docs
  • Loading branch information
yanokwa authored Sep 3, 2021
2 parents b11a2a4 + 1176197 commit 96faac6
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
4 changes: 3 additions & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ <h1 id="enketo-transformer">Enketo Transformer</h1>
<p><a href="https://enketo.github.io/enketo-transformer/">Technical Documentation</a></p>
<h3 id="prerequisites">Prerequisites</h3>
<ol>
<li>Volta (optional, but recommended)</li>
<li>Node.js 16 and npm 6 (Node.js 14 is also supported)</li>
</ol>
<h3 id="install-as-module">Install as module</h3>
Expand Down Expand Up @@ -154,7 +155,8 @@ <h3 id="release">Release</h3>
<p>Releases are done each time a dependent tool needs an <code>enketo-transformer</code> change. They are published by <a href="https://github.com/MartijnR">@Martijnr</a> and require the following steps:</p>
<ul>
<li>update <a href="https://github.com/enketo/enketo-transformer/blob/master/CHANGELOG.md">change log</a></li>
<li>update version in <code>package.json</code></li>
<li>update version in <code>package.json</code>. Bump to major version if downstream has to make changes.</li>
<li>check <a href="https://github.com/enketo/enketo-transformer/security/dependabot">Dependabot alerts</a> for vulnerabilities</li>
<li>update dependencies (<code>npm update</code> and then check if <code>node-libxslt</code> has been updated because it has caused problems in the past).</li>
<li><code>npm audit fix</code></li>
<li><code>npm run build-docs</code></li>
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 96faac6

Please sign in to comment.