Skip to content

Commit c3d9d3d

Browse files
committed
Updating documentation.
1 parent 9740b77 commit c3d9d3d

16 files changed

+426
-225
lines changed

docs/bpmnDsl.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -76,11 +76,11 @@
7676
<li class="level2 nav-leaf"><a href="functionalityDsls/simulation.html">Simulations</a></li>
7777
<li class="level2 nav-leaf"><a href="functionalityDsls/worker.html">Workers</a></li>
7878
<li class="level2 nav-leaf"><a href="functionalityDsls/dmnTester.html">DMN Tester</a></li>
79-
<li class="level1 nav-header">helper</li>
80-
<li class="level2 nav-leaf"><a href="helper/development.html">Development</a></li>
81-
<li class="level2 nav-leaf"><a href="helper/initCompany.html">Init Company</a></li>
82-
<li class="level2 nav-leaf"><a href="helper/createProject.html">Create Project</a></li>
83-
<li class="level2 nav-leaf"><a href="helper/projectDev.html">Project Development</a></li>
79+
<li class="level1 nav-header">development</li>
80+
<li class="level2 nav-leaf"><a href="development/intro.html">Introduction</a></li>
81+
<li class="level2 nav-leaf"><a href="development/initCompany.html">Init Company</a></li>
82+
<li class="level2 nav-leaf"><a href="development/createProject.html">Create Project</a></li>
83+
<li class="level2 nav-leaf"><a href="development/projectDev.html">Project Development</a></li>
8484
</ul>
8585

8686
</nav>

docs/helper/createProject.html renamed to docs/development/createProject.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,8 @@
7676
<li class="level2 nav-leaf"><a href="../functionalityDsls/simulation.html">Simulations</a></li>
7777
<li class="level2 nav-leaf"><a href="../functionalityDsls/worker.html">Workers</a></li>
7878
<li class="level2 nav-leaf"><a href="../functionalityDsls/dmnTester.html">DMN Tester</a></li>
79-
<li class="level1 nav-header">helper</li>
80-
<li class="level2 nav-leaf"><a href="development.html">Development</a></li>
79+
<li class="level1 nav-header">development</li>
80+
<li class="level2 nav-leaf"><a href="intro.html">Introduction</a></li>
8181
<li class="level2 nav-leaf"><a href="initCompany.html">Init Company</a></li>
8282
<li class="level2 active nav-leaf"><a href="#">Create Project</a></li>
8383
<li class="level2 nav-leaf"><a href="projectDev.html">Project Development</a></li>
@@ -112,10 +112,10 @@ <h1 id="create-project" class="title">Create Project</h1>
112112
<ol class="arabic">
113113
<li>
114114
<p>We can use the same <code>helperCompany.scala</code> script, we created in the <a href="initCompany.html#init-company">Init Company</a> step.</p>
115-
<pre class="keep-together pdf epub"><code class="nohighlight"><span class="identifier">cd</span><span> ~/</span><span class="identifier">dev</span><span>-</span><span class="identifier">myCompany</span><span>
115+
<pre class="keep-together pdf epub"><code class="nohighlight"><span class="identifier">cd</span><span> ~/</span><span class="identifier">dev</span><span>-</span><span class="identifier">mycompany</span><span>
116116
./</span><span class="identifier">helperCompany</span><span>.</span><span class="identifier">scala</span><span> </span><span class="identifier">project</span><span> </span><span class="identifier">myProject</span></code></pre>
117117
<p>This creates:</p>
118-
<pre class="keep-together pdf epub"><code class="nohighlight"><span>dev-myCompany
118+
<pre class="keep-together pdf epub"><code class="nohighlight"><span>dev-mycompany
119119
| projects
120120
| | myProject
121121
| | | helper.scala</span></code></pre>
@@ -126,17 +126,17 @@ <h1 id="create-project" class="title">Create Project</h1>
126126
chmod +x helper.scala</span></code></pre>
127127
</li>
128128
<li>
129-
<p>Open the <code>myCompany-myProject</code> directory with your IDE (I use Intellij).</p>
129+
<p>Open the <code>mycompany-myProject</code> directory with your IDE (I use Intellij).</p>
130130
</li>
131131
</ol>
132132
<div class="callout info">
133133
<i class="icofont-laika info">&#xef4e;</i>
134134
<p>If you haven&#39;t released <code>company-camundala</code> yet,
135135
you need to run it at least locally (<code>sbt publishLocal</code>)
136136
and set the version in the <code>helper.scala</code> manually.</p>
137-
<pre class="keep-together pdf epub"><code class="nohighlight"><span class="comment">//&gt; using dep myCompany::myCompany-camundala-helper:VERSION NOT FOUND
137+
<pre class="keep-together pdf epub"><code class="nohighlight"><span class="comment">//&gt; using dep mycompany::mycompany-camundala-helper:VERSION NOT FOUND
138138
// replace with:
139-
//&gt; using dep myCompany::myCompany-camundala-helper:0.1.0-SNAPSHOT</span></code></pre>
139+
//&gt; using dep mycompany::mycompany-camundala-helper:0.1.0-SNAPSHOT</span></code></pre>
140140
</div>
141141

142142
<h3 id="next-step-project-development" class="section"><a class="anchor-link left" href="#next-step-project-development"><i class="icofont-laika link">&#xef71;</i></a>Next Step: <a href="projectDev.html#project-development">Project Development</a></h3>

docs/helper/initCompany.html renamed to docs/development/initCompany.html

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,8 @@
7676
<li class="level2 nav-leaf"><a href="../functionalityDsls/simulation.html">Simulations</a></li>
7777
<li class="level2 nav-leaf"><a href="../functionalityDsls/worker.html">Workers</a></li>
7878
<li class="level2 nav-leaf"><a href="../functionalityDsls/dmnTester.html">DMN Tester</a></li>
79-
<li class="level1 nav-header">helper</li>
80-
<li class="level2 nav-leaf"><a href="development.html">Development</a></li>
79+
<li class="level1 nav-header">development</li>
80+
<li class="level2 nav-leaf"><a href="intro.html">Introduction</a></li>
8181
<li class="level2 active nav-leaf"><a href="#">Init Company</a></li>
8282
<li class="level2 nav-leaf"><a href="createProject.html">Create Project</a></li>
8383
<li class="level2 nav-leaf"><a href="projectDev.html">Project Development</a></li>
@@ -120,11 +120,12 @@ <h1 id="init-company" class="title">Init Company</h1>
120120
<ol class="arabic">
121121
<li>
122122
<p>Create a directory for your company development:</p>
123-
<pre class="keep-together pdf epub"><code class="nohighlight"><span>mkdir ~/dev-myCompany</span></code></pre>
123+
<pre class="keep-together pdf epub"><code class="nohighlight"><span>mkdir ~/dev-mycompany</span></code></pre>
124+
<p>Be aware that the company name (<em>mycompany</em>) must be lowercase to work properly.</p>
124125
</li>
125126
<li>
126127
<p>Create <code>helperCompany.scala</code> in your company directory and open it.</p>
127-
<pre class="keep-together pdf epub"><code class="nohighlight"><span class="identifier">cd</span><span> ~/dev-myCompany
128+
<pre class="keep-together pdf epub"><code class="nohighlight"><span class="identifier">cd</span><span> ~/dev-mycompany
128129
touch helperCompany.scala
129130
open helperCompany.scala</span></code></pre>
130131
</li>
@@ -134,7 +135,7 @@ <h1 id="init-company" class="title">Init Company</h1>
134135
</span><span class="comment">// DO NOT ADJUST. This file is replaced by `./helper.scala update`.
135136
</span><span>
136137
</span><span class="comment">//&gt; using toolkit 0.5.0
137-
//&gt; using dep io.github.pme123::camundala-helper:0.31.0-SNAPSHOT
138+
//&gt; using dep io.github.pme123::camundala-helper:1.31.0-SNAPSHOT
138139
</span><span>
139140
</span><span class="keyword">import</span><span> </span><span class="identifier">camundala</span><span>.</span><span class="identifier">helper</span><span>.</span><span class="identifier">dev</span><span>.</span><span class="type-name">DevCompanyRunner</span><span>
140141

docs/helper/development.html renamed to docs/development/intro.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<meta charset="utf-8">
77
<meta name="viewport" content="width=device-width, initial-scale=1.0">
88
<meta name="generator" content="Typelevel Laika + Helium Theme" />
9-
<title>Development</title>
9+
<title>Introduction</title>
1010

1111

1212
<meta name="description" content="camundala-docs"/>
@@ -76,8 +76,8 @@
7676
<li class="level2 nav-leaf"><a href="../functionalityDsls/simulation.html">Simulations</a></li>
7777
<li class="level2 nav-leaf"><a href="../functionalityDsls/worker.html">Workers</a></li>
7878
<li class="level2 nav-leaf"><a href="../functionalityDsls/dmnTester.html">DMN Tester</a></li>
79-
<li class="level1 nav-header">helper</li>
80-
<li class="level2 active nav-leaf"><a href="#">Development</a></li>
79+
<li class="level1 nav-header">development</li>
80+
<li class="level2 active nav-leaf"><a href="#">Introduction</a></li>
8181
<li class="level2 nav-leaf"><a href="initCompany.html">Init Company</a></li>
8282
<li class="level2 nav-leaf"><a href="createProject.html">Create Project</a></li>
8383
<li class="level2 nav-leaf"><a href="projectDev.html">Project Development</a></li>
@@ -89,7 +89,7 @@
8989

9090

9191
<nav id="page-nav">
92-
<p class="header"><a href="#">Development</a></p>
92+
<p class="header"><a href="#">Introduction</a></p>
9393

9494
<ul class="nav-list">
9595
<li class="level1 nav-leaf"><a href="#pre-requisites">Pre-Requisites</a></li>
@@ -101,7 +101,7 @@
101101

102102
<main class="content">
103103

104-
<h1 id="development" class="title">Development</h1>
104+
<h1 id="introduction" class="title">Introduction</h1>
105105

106106
<h2 id="pre-requisites" class="section"><a class="anchor-link left" href="#pre-requisites"><i class="icofont-laika link">&#xef71;</i></a>Pre-Requisites</h2>
107107
<p><strong><em>Camundala</em></strong> is written in <em><strong>Scala</strong></em> and provides <em>Scala DSLs</em>.

0 commit comments

Comments
 (0)