Skip to content

Commit

Permalink
Updating documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
@pme123
pme123 committed Dec 14, 2024
1 parent 9740b77 commit c3d9d3d
Show file tree
Hide file tree
Showing 16 changed files with 426 additions and 225 deletions.
10 changes: 5 additions & 5 deletions docs/bpmnDsl.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,11 +76,11 @@
<li class="level2 nav-leaf"><a href="functionalityDsls/simulation.html">Simulations</a></li>
<li class="level2 nav-leaf"><a href="functionalityDsls/worker.html">Workers</a></li>
<li class="level2 nav-leaf"><a href="functionalityDsls/dmnTester.html">DMN Tester</a></li>
<li class="level1 nav-header">helper</li>
<li class="level2 nav-leaf"><a href="helper/development.html">Development</a></li>
<li class="level2 nav-leaf"><a href="helper/initCompany.html">Init Company</a></li>
<li class="level2 nav-leaf"><a href="helper/createProject.html">Create Project</a></li>
<li class="level2 nav-leaf"><a href="helper/projectDev.html">Project Development</a></li>
<li class="level1 nav-header">development</li>
<li class="level2 nav-leaf"><a href="development/intro.html">Introduction</a></li>
<li class="level2 nav-leaf"><a href="development/initCompany.html">Init Company</a></li>
<li class="level2 nav-leaf"><a href="development/createProject.html">Create Project</a></li>
<li class="level2 nav-leaf"><a href="development/projectDev.html">Project Development</a></li>
</ul>

</nav>
Expand Down
14 changes: 7 additions & 7 deletions docs/helper/createProject.html → docs/development/createProject.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,8 @@
<li class="level2 nav-leaf"><a href="../functionalityDsls/simulation.html">Simulations</a></li>
<li class="level2 nav-leaf"><a href="../functionalityDsls/worker.html">Workers</a></li>
<li class="level2 nav-leaf"><a href="../functionalityDsls/dmnTester.html">DMN Tester</a></li>
<li class="level1 nav-header">helper</li>
<li class="level2 nav-leaf"><a href="development.html">Development</a></li>
<li class="level1 nav-header">development</li>
<li class="level2 nav-leaf"><a href="intro.html">Introduction</a></li>
<li class="level2 nav-leaf"><a href="initCompany.html">Init Company</a></li>
<li class="level2 active nav-leaf"><a href="#">Create Project</a></li>
<li class="level2 nav-leaf"><a href="projectDev.html">Project Development</a></li>
Expand Down Expand Up @@ -112,10 +112,10 @@ <h1 id="create-project" class="title">Create Project</h1>
<ol class="arabic">
<li>
<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>
<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>
<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>
./</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>
<p>This creates:</p>
<pre class="keep-together pdf epub"><code class="nohighlight"><span>dev-myCompany
<pre class="keep-together pdf epub"><code class="nohighlight"><span>dev-mycompany
| projects
| | myProject
| | | helper.scala</span></code></pre>
Expand All @@ -126,17 +126,17 @@ <h1 id="create-project" class="title">Create Project</h1>
chmod +x helper.scala</span></code></pre>
</li>
<li>
<p>Open the <code>myCompany-myProject</code> directory with your IDE (I use Intellij).</p>
<p>Open the <code>mycompany-myProject</code> directory with your IDE (I use Intellij).</p>
</li>
</ol>
<div class="callout info">
<i class="icofont-laika info">&#xef4e;</i>
<p>If you haven&#39;t released <code>company-camundala</code> yet,
you need to run it at least locally (<code>sbt publishLocal</code>)
and set the version in the <code>helper.scala</code> manually.</p>
<pre class="keep-together pdf epub"><code class="nohighlight"><span class="comment">//&gt; using dep myCompany::myCompany-camundala-helper:VERSION NOT FOUND
<pre class="keep-together pdf epub"><code class="nohighlight"><span class="comment">//&gt; using dep mycompany::mycompany-camundala-helper:VERSION NOT FOUND
// replace with:
//&gt; using dep myCompany::myCompany-camundala-helper:0.1.0-SNAPSHOT</span></code></pre>
//&gt; using dep mycompany::mycompany-camundala-helper:0.1.0-SNAPSHOT</span></code></pre>
</div>

<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>
Expand Down
11 changes: 6 additions & 5 deletions docs/helper/initCompany.html → docs/development/initCompany.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,8 @@
<li class="level2 nav-leaf"><a href="../functionalityDsls/simulation.html">Simulations</a></li>
<li class="level2 nav-leaf"><a href="../functionalityDsls/worker.html">Workers</a></li>
<li class="level2 nav-leaf"><a href="../functionalityDsls/dmnTester.html">DMN Tester</a></li>
<li class="level1 nav-header">helper</li>
<li class="level2 nav-leaf"><a href="development.html">Development</a></li>
<li class="level1 nav-header">development</li>
<li class="level2 nav-leaf"><a href="intro.html">Introduction</a></li>
<li class="level2 active nav-leaf"><a href="#">Init Company</a></li>
<li class="level2 nav-leaf"><a href="createProject.html">Create Project</a></li>
<li class="level2 nav-leaf"><a href="projectDev.html">Project Development</a></li>
Expand Down Expand Up @@ -120,11 +120,12 @@ <h1 id="init-company" class="title">Init Company</h1>
<ol class="arabic">
<li>
<p>Create a directory for your company development:</p>
<pre class="keep-together pdf epub"><code class="nohighlight"><span>mkdir ~/dev-myCompany</span></code></pre>
<pre class="keep-together pdf epub"><code class="nohighlight"><span>mkdir ~/dev-mycompany</span></code></pre>
<p>Be aware that the company name (<em>mycompany</em>) must be lowercase to work properly.</p>
</li>
<li>
<p>Create <code>helperCompany.scala</code> in your company directory and open it.</p>
<pre class="keep-together pdf epub"><code class="nohighlight"><span class="identifier">cd</span><span> ~/dev-myCompany
<pre class="keep-together pdf epub"><code class="nohighlight"><span class="identifier">cd</span><span> ~/dev-mycompany
touch helperCompany.scala
open helperCompany.scala</span></code></pre>
</li>
Expand All @@ -134,7 +135,7 @@ <h1 id="init-company" class="title">Init Company</h1>
</span><span class="comment">// DO NOT ADJUST. This file is replaced by `./helper.scala update`.
</span><span>
</span><span class="comment">//&gt; using toolkit 0.5.0
//&gt; using dep io.github.pme123::camundala-helper:0.31.0-SNAPSHOT
//&gt; using dep io.github.pme123::camundala-helper:1.31.0-SNAPSHOT
</span><span>
</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>

Expand Down
10 changes: 5 additions & 5 deletions docs/helper/development.html → docs/development/intro.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Typelevel Laika + Helium Theme" />
<title>Development</title>
<title>Introduction</title>


<meta name="description" content="camundala-docs"/>
Expand Down Expand Up @@ -76,8 +76,8 @@
<li class="level2 nav-leaf"><a href="../functionalityDsls/simulation.html">Simulations</a></li>
<li class="level2 nav-leaf"><a href="../functionalityDsls/worker.html">Workers</a></li>
<li class="level2 nav-leaf"><a href="../functionalityDsls/dmnTester.html">DMN Tester</a></li>
<li class="level1 nav-header">helper</li>
<li class="level2 active nav-leaf"><a href="#">Development</a></li>
<li class="level1 nav-header">development</li>
<li class="level2 active nav-leaf"><a href="#">Introduction</a></li>
<li class="level2 nav-leaf"><a href="initCompany.html">Init Company</a></li>
<li class="level2 nav-leaf"><a href="createProject.html">Create Project</a></li>
<li class="level2 nav-leaf"><a href="projectDev.html">Project Development</a></li>
Expand All @@ -89,7 +89,7 @@


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

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

<main class="content">

<h1 id="development" class="title">Development</h1>
<h1 id="introduction" class="title">Introduction</h1>

<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>
<p><strong><em>Camundala</em></strong> is written in <em><strong>Scala</strong></em> and provides <em>Scala DSLs</em>.
Expand Down
Loading

0 comments on commit c3d9d3d

Please sign in to comment.