Merge pull request #103 from mediumroast/alpha_2

Alpha 2 - formal release for v0.0.6-interaction-repository
mediumroast · Mar 17, 2024 · a8e5cf4 · a8e5cf4
2 parents c6c3ca3 + 68aa12e
commit a8e5cf4
Show file tree

Hide file tree

Showing 27 changed files with 42 additions and 27 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 ## Welcome to Open Source Mediumroast for GitHub.
 Products organizations must build robust product plans from competitive and customer interactions everyone can see, use, and reference. Therefore, Mediumroast for GitHub intends to help Products oranizations construct an active interactions repository close to the action of development and issue management in GitHub.
 
-**Notice:** We recommend that you review the [GitHub Page Version](https://mediumroast.github.io/mediumroast_js/) rather than the repository version. 
+**Notice:** You can review the [GitHub Page Version](https://mediumroast.github.io/mediumroast_js/) rather than the repository version of this documentation, but the screencasts of several of the CLI tutorials will not display. 
 
 ## Installation and configuration
 Mediumroast for GitHub includes a [GitHub Application](https://github.com/apps/mediumroast-for-github), a Command Line Interface, and a Software Development Kit.  The following steps show you how to install the App and the CLI with SDK.
@@ -33,7 +33,7 @@ Assuming the preinstallation requirements, installation of *node.js* and *npm*,
 Coming soon.
 
 ### Step 3 - Setup the CLI
-Before you can use the Mediumroast for GitHub CLI the environment must be setup.  With the CLI installed please run `mrcli setup` to start the setup process, note there's a video of the setup process in CLI README.
+Before you can use the Mediumroast for GitHub [CLI](https://github.com/mediumroast/mediumroast_js/blob/main/cli/README.md) the environment must be setup.  With the CLI installed please run `mrcli setup` to start the setup process, note there's a video of the setup process in CLI README.
 
 ## What's provided
 Running `mrcli setup` creates a repository in your oganization called `<organization_name>_discovery` for all interactions and objects, creates two intitial companies, and installs two GitHub Actions to control the number of branches and provide some basic out of the box reporting -- see example screenshot below.

diff --git a/cli/Company.md b/cli/Company.md
@@ -77,6 +77,7 @@ To update a company attribute the `--update` switch is provided.  A properly for
 - `mrcli c --update='{"name": "Atlassian Corp", "key": "company_type", "value": "Public"}'`
 
 ### Screencast with output
+**Notice**: Only the markdown version rendered through the GitHub web interface will display the screencast.  If you're viewing these files through the [GitHub Page Version](https://mediumroast.github.io/mediumroast_js/tutorial-Company.html) the link below will just show up as text.
 
 https://github.com/mediumroast/mediumroast_js/assets/10818650/a74cb8cd-f8cb-4a8d-8968-ccf9b875d86b
 

diff --git a/cli/Interaction.md b/cli/Interaction.md
@@ -85,6 +85,7 @@ To update an interaction attribute the `--update` switch is provided.  A properl
 - `mrcli c --update='{"name": "Atlassian Corp", "key": "company_type", "value": "Public"}'`
 
 ### Screencast with output
+**Notice**: Only the markdown version rendered through the GitHub web interface will display the screencast.  If you're viewing these files through the [GitHub Page Version](https://mediumroast.github.io/mediumroast_js/tutorial-Interaction.html) the link below will just show up as text.
 
 https://github.com/mediumroast/mediumroast_js/assets/10818650/e11256e7-28ca-47d5-b131-58a2036671a6
 
@@ -105,6 +106,7 @@ A command line prompt based wizard steps the user through a semi-automated proce
 - `mrcli i --add_wizard`
 
 ### Screencast with output
+**Notice**: Only the markdown version rendered through the GitHub web interface will display the screencast.  If you're viewing these files through the [GitHub Page Version](https://mediumroast.github.io/mediumroast_js/tutorial-Interaction.html) the link below will just show up as text.
 
 https://github.com/mediumroast/mediumroast_js/assets/10818650/0b28db90-d6ba-4224-a9ae-4c301c2b9614
 

diff --git a/cli/README.md b/cli/README.md
@@ -23,12 +23,18 @@ Provides reports for consumed actions and repository storage consumed by the org
 
 ## Setup
 To help users quickly get on board with **Mediumroast for GitHub** the setup CLI is used.  This CLI creates the `${HOME}/.mediumroast/config.ini` file, creates the repository including key directories, and creates two initial companies.  A screencast video showing the process for setting up the CLI environment and creating two companies is available below.
+
 ### Command(s) run
 - `mrcli setup`
 ### Screencast showing setup process
+**Notice**: Only the markdown version rendered through the GitHub web interface will display the screencast.  If you're viewing these files through the [GitHub Page Version](https://mediumroast.github.io/mediumroast_js/tutorial-README.html) the link below will just show up as text.
 
 https://github.com/mediumroast/mediumroast_js/assets/10818650/68c08502-4f59-4981-a001-0d9c9bd1d4d2
 
+---
+
+[[Company Subcommand](https://github.com/mediumroast/mediumroast_js/blob/main/cli/Company.md)] | [[Interaction Subcommand](https://github.com/mediumroast/mediumroast_js/blob/main/cli/Interaction.md)]
+
 
 
 
diff --git a/cli/mrcli.js b/cli/mrcli.js
@@ -14,7 +14,7 @@ import program from 'commander'
 
 program
   .name('mrcli')
-  .version('0.4.48')
+  .version('0.6.0')
   .description('mediumroast.io command line interface')
   .command('setup', 'setup the mediumroast.io system via the command line').alias('f')
   .command('interaction', 'manage and report on mediumroast.io interaction objects').alias('i')

diff --git a/docs/Billings.html b/docs/Billings.html
@@ -354,7 +354,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 
-		on Thu Mar 14th 2024
+		on Sun Mar 17th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/Companies.html b/docs/Companies.html
@@ -354,7 +354,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 
-		on Thu Mar 14th 2024
+		on Sun Mar 17th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/GitHubFunctions.GitHubFunctions.html b/docs/GitHubFunctions.GitHubFunctions.html
@@ -354,7 +354,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 
-		on Thu Mar 14th 2024
+		on Sun Mar 17th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/Interactions.html b/docs/Interactions.html
@@ -354,7 +354,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 
-		on Thu Mar 14th 2024
+		on Sun Mar 17th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/Studies.html b/docs/Studies.html
@@ -354,7 +354,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 
-		on Thu Mar 14th 2024
+		on Sun Mar 17th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/Users.html b/docs/Users.html
@@ -354,7 +354,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 
-		on Thu Mar 14th 2024
+		on Sun Mar 17th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/authorize.js.html b/docs/authorize.js.html
@@ -405,7 +405,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 
-		on Thu Mar 14th 2024
+		on Sun Mar 17th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/baseObjects.html b/docs/baseObjects.html
@@ -318,7 +318,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 
-		on Thu Mar 14th 2024
+		on Sun Mar 17th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/classes.list.html b/docs/classes.list.html
@@ -239,7 +239,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 
-		on Thu Mar 14th 2024
+		on Sun Mar 17th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/gitHubServer.js.html b/docs/gitHubServer.js.html
@@ -614,7 +614,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 
-		on Thu Mar 14th 2024
+		on Sun Mar 17th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/github.js.html b/docs/github.js.html
@@ -1044,7 +1044,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 
-		on Thu Mar 14th 2024
+		on Sun Mar 17th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/global.html b/docs/global.html
@@ -1576,7 +1576,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 
-		on Thu Mar 14th 2024
+		on Sun Mar 17th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/index.html b/docs/index.html
@@ -112,7 +112,7 @@ <h3>mediumroast_js 0.4.48</h3>
     <section class="readme-section">
         <article><h2>Welcome to Open Source Mediumroast for GitHub.</h2>
 <p>Products organizations must build robust product plans from competitive and customer interactions everyone can see, use, and reference. Therefore, Mediumroast for GitHub intends to help Products oranizations construct an active interactions repository close to the action of development and issue management in GitHub.</p>
-<p><strong>Notice:</strong> We recommend that you review the <a href="https://mediumroast.github.io/mediumroast_js/">GitHub Page Version</a> rather than the repository version.</p>
+<p><strong>Notice:</strong> You can review the <a href="https://mediumroast.github.io/mediumroast_js/">GitHub Page Version</a> rather than the repository version of this documentation, but the screencasts of several of the CLI tutorials will not display.</p>
 <h2>Installation and configuration</h2>
 <p>Mediumroast for GitHub includes a <a href="https://github.com/apps/mediumroast-for-github">GitHub Application</a>, a Command Line Interface, and a Software Development Kit.  The following steps show you how to install the App and the CLI with SDK.</p>
 <h3>Preinstallation requirements</h3>
@@ -142,7 +142,7 @@ <h4>For Linux and MacOS</h4>
 <h4>For WinOS</h4>
 <p>Coming soon.</p>
 <h3>Step 3 - Setup the CLI</h3>
-<p>Before you can use the Mediumroast for GitHub CLI the environment must be setup.  With the CLI installed please run <code>mrcli setup</code> to start the setup process, note there's a video of the setup process in CLI README.</p>
+<p>Before you can use the Mediumroast for GitHub <a href="https://github.com/mediumroast/mediumroast_js/blob/main/cli/README.md">CLI</a> the environment must be setup.  With the CLI installed please run <code>mrcli setup</code> to start the setup process, note there's a video of the setup process in CLI README.</p>
 <h2>What's provided</h2>
 <p>Running <code>mrcli setup</code> creates a repository in your oganization called <code>&lt;organization_name&gt;_discovery</code> for all interactions and objects, creates two intitial companies, and installs two GitHub Actions to control the number of branches and provide some basic out of the box reporting -- see example screenshot below.</p>
 <h3>Warning</h3>
@@ -200,7 +200,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 
-		on Thu Mar 14th 2024
+		on Sun Mar 17th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-GitHubAuth.html b/docs/module-GitHubAuth.html
@@ -273,7 +273,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 
-		on Thu Mar 14th 2024
+		on Sun Mar 17th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-GitHubFunctions.html b/docs/module-GitHubFunctions.html
@@ -1066,7 +1066,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 
-		on Thu Mar 14th 2024
+		on Sun Mar 17th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/modules.list.html b/docs/modules.list.html
@@ -239,7 +239,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 
-		on Thu Mar 14th 2024
+		on Sun Mar 17th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/quicksearch.html b/docs/quicksearch.html
diff --git a/docs/tutorial-Company.html b/docs/tutorial-Company.html
@@ -162,6 +162,7 @@ <h3>Command(s) run</h3>
 <li><code>mrcli c --update='{&quot;name&quot;: &quot;Atlassian Corp&quot;, &quot;key&quot;: &quot;company_type&quot;, &quot;value&quot;: &quot;Public&quot;}'</code></li>
 </ul>
 <h3>Screencast with output</h3>
+<p><strong>Notice</strong>: Only the markdown version rendered through the GitHub web interface will display the screencast.  If you're viewing these files through the <a href="https://mediumroast.github.io/mediumroast_js/tutorial-Company.html">GitHub Page Version</a> the link below will just show up as text.</p>
 <p>https://github.com/mediumroast/mediumroast_js/assets/10818650/a74cb8cd-f8cb-4a8d-8968-ccf9b875d86b</p>
 <h2>Delete a company</h2>
 <p>Remove a company and associated interactions if in the repository. There is a confirmation prompt which defaults to yes. Note that the exact company name is needed to proceed with a deletion.</p>
@@ -220,7 +221,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 
-		on Thu Mar 14th 2024
+		on Sun Mar 17th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/tutorial-Interaction.html b/docs/tutorial-Interaction.html
@@ -162,6 +162,7 @@ <h3>Command(s) run</h3>
 <li><code>mrcli c --update='{&quot;name&quot;: &quot;Atlassian Corp&quot;, &quot;key&quot;: &quot;company_type&quot;, &quot;value&quot;: &quot;Public&quot;}'</code></li>
 </ul>
 <h3>Screencast with output</h3>
+<p><strong>Notice</strong>: Only the markdown version rendered through the GitHub web interface will display the screencast.  If you're viewing these files through the <a href="https://mediumroast.github.io/mediumroast_js/tutorial-Interaction.html">GitHub Page Version</a> the link below will just show up as text.</p>
 <p>https://github.com/mediumroast/mediumroast_js/assets/10818650/e11256e7-28ca-47d5-b131-58a2036671a6</p>
 <h2>Delete an interaction</h2>
 <p>Remove a company and associated interactions if in the repository. There is a confirmation prompt which defaults to yes. Note that the exact company name is needed to proceed with a deletion.</p>
@@ -178,6 +179,7 @@ <h3>Command(s) run</h3>
 <li><code>mrcli i --add_wizard</code></li>
 </ul>
 <h3>Screencast with output</h3>
+<p><strong>Notice</strong>: Only the markdown version rendered through the GitHub web interface will display the screencast.  If you're viewing these files through the <a href="https://mediumroast.github.io/mediumroast_js/tutorial-Interaction.html">GitHub Page Version</a> the link below will just show up as text.</p>
 <p>https://github.com/mediumroast/mediumroast_js/assets/10818650/0b28db90-d6ba-4224-a9ae-4c301c2b9614</p>
 </article>
 
@@ -220,7 +222,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 
-		on Thu Mar 14th 2024
+		on Sun Mar 17th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/tutorial-README.html b/docs/tutorial-README.html
@@ -124,7 +124,10 @@ <h3>Command(s) run</h3>
 <li><code>mrcli setup</code></li>
 </ul>
 <h3>Screencast showing setup process</h3>
+<p><strong>Notice</strong>: Only the markdown version rendered through the GitHub web interface will display the screencast.  If you're viewing these files through the <a href="https://mediumroast.github.io/mediumroast_js/tutorial-README.html">GitHub Page Version</a> the link below will just show up as text.</p>
 <p>https://github.com/mediumroast/mediumroast_js/assets/10818650/68c08502-4f59-4981-a001-0d9c9bd1d4d2</p>
+<hr>
+<p>[<a href="https://github.com/mediumroast/mediumroast_js/blob/main/cli/Company.md">Company Subcommand</a>] | [<a href="https://github.com/mediumroast/mediumroast_js/blob/main/cli/Interaction.md">Interaction Subcommand</a>]</p>
 </article>
 
 </section>
@@ -166,7 +169,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 
-		on Thu Mar 14th 2024
+		on Sun Mar 17th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/tutorials.list.html b/docs/tutorials.list.html
@@ -239,7 +239,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 
-		on Thu Mar 14th 2024
+		on Sun Mar 17th 2024
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "mediumroast_js",
-  "version": "0.4.48",
+  "version": "0.6.0",
   "description": "A Command Line Interface (CLI) and Javascript SDK to interact with mediumroast.io.",
   "main": "cli/mrcli.js",
   "scripts": {