Update top level of resource documentation

Author: Itai Gendler

auto-docs/index.js

@@ -3,9 +3,11 @@ const recursive = require('recursive-readdir');
 const path = require('path');
 const _ = require('lodash');
 
-
 recursive(path.resolve(__dirname, '../lib/interface/cli/commands'), (err, files) => {
 
+    const baseDir = path.resolve(__dirname, '../docs-template/content');
+    const categories = {};
+
     _.forEach(files, (file) => {
         if (!file.endsWith('.cmd.js')) {
             return;
@@ -27,16 +29,24 @@ recursive(path.resolve(__dirname, '../lib/interface/cli/commands'), (err, files)
         const { category } = docs;
 
         // create a directory according to the category
-        const dir = path.resolve(__dirname, `../docs-template/content/${(category || 'undefined').toLowerCase()}`);
-        if (!fs.existsSync(dir)){
+        const dir = path.resolve(baseDir, `${(category || 'undefined').toLowerCase()}`);
+        if (!fs.existsSync(dir)) {
             fs.mkdirSync(dir);
         }
 
-        // create _index.md file if does not exist for the category
-        const indexFile = path.resolve(dir, '_index.md');
-        if (!fs.existsSync(indexFile)){
-            fs.writeFileSync(indexFile, `+++\ntitle = "${category}"\n+++`);
-        }
+        let finalCategoryFileString = categories[category] || `+++\ntitle = "${category}"\n+++\n\n`;
+        const formattedTitle = docs.title.replace(/\s+/g, '-').toLowerCase();
+        finalCategoryFileString += `### [${docs.title}](${formattedTitle})\n`;
+        finalCategoryFileString += `\`${docs.command}\`\n\n`;
+        finalCategoryFileString += `${docs.description}\n\n`;
+        categories[category] = finalCategoryFileString;
+
+
+        // // create _index.md file if does not exist for the category
+        // const indexFile = path.resolve(dir, '_index.md');
+        // if (!fs.existsSync(indexFile)){
+        //     fs.writeFileSync(indexFile, `+++\ntitle = "${category}"\n+++`);
+        // }
 
         let finalFileString = '';
 
@@ -55,4 +65,9 @@ recursive(path.resolve(__dirname, '../lib/interface/cli/commands'), (err, files)
 
         fs.writeFileSync(path.resolve(dir, `./${docs.title}.md`), finalFileString);
     });
+
+    _.forEach(categories, (content, category) => {
+        const indexFile = path.resolve(baseDir, `./${(category || 'undefined').toLowerCase()}/_index.md`);
+        fs.writeFileSync(indexFile, content);
+    });
 });

docs-template/content/authentication/_index.md

@@ -1,5 +1,24 @@
 +++
 title = "Authentication"
-date = "2017-04-24T18:36:24+02:00"
-weight = 30
 +++
+
+### [Create authentication context](create-authentication-context)
+`codefresh create-context [name]`
+
+Create or update an authentication context
+
+### [Get activated context](get-activated-context)
+`codefresh current-context`
+
+Get the current activated authentication context
+
+### [Get all contexts](get-all-contexts)
+`codefresh get-contexts`
+
+Get all possible authentication contexts
+
+### [Set active context](set-active-context)
+`codefresh use-context <name>`
+
+Set the current active authentication context
+

docs-template/content/builds/_index.md

@@ -1,4 +1,29 @@
 +++
 title = "Builds"
-weight = 70
 +++
+
+### [Get a single build](get-a-single-build)
+`codefresh builds [id]`
+
+Get a specific builds or an array of builds
+
+### [Show logs](show-logs)
+`codefresh logs <id>`
+
+Show logs of a build
+
+### [Restart a build](restart-a-build)
+`codefresh restart <id>`
+
+Restart a build by its id
+
+### [Terminate a build](terminate-a-build)
+`codefresh terminate <id>`
+
+Terminate a build by its id
+
+### [Wait for a build condition](wait-for-a-build-condition)
+`codefresh wait <id..>`
+
+Wait until a condition will be met on a build
+

docs-template/content/compositions/_index.md

@@ -1,4 +1,24 @@
 +++
 title = "Compositions"
-weight = 90
 +++
+
+### [Create a composition](create-a-composition)
+`codefresh composition [name]`
+
+Create a composition
+
+### [Delete a composition](delete-a-composition)
+`codefresh composition [name]`
+
+Delete a composition
+
+### [Get a single composition](get-a-single-composition)
+`codefresh compositions [id|name]`
+
+Get a specific composition or an array of compositions
+
+### [Replace a composition](replace-a-composition)
+`codefresh composition`
+
+Replace a composition resource
+

docs-template/content/contexts/_index.md

@@ -1,4 +1,29 @@
 +++
 title = "Contexts"
-weight = 40
 +++
+
+### [Updated a context](updated-a-context)
+`codefresh context`
+
+Apply changes to a context
+
+### [Create a context](create-a-context)
+`codefresh context [type] [name]`
+
+Create a context
+
+### [Delete a context](delete-a-context)
+`codefresh context [name]`
+
+Delete a context
+
+### [Get a single context](get-a-single-context)
+`codefresh contexts [name]`
+
+Get a specific or an array of contexts
+
+### [Replace a context](replace-a-context)
+`codefresh context`
+
+Replace a context
+

docs-template/content/environments/_index.md

@@ -1,4 +1,14 @@
 +++
 title = "Environments"
-weight = 100
 +++
+
+### [Delete an environment](delete-an-environment)
+`codefresh environment <id>`
+
+Delete an environment
+
+### [Get a single composition](get-a-single-composition)
+`codefresh environments [id]`
+
+Get a specific or an array of environments
+

docs-template/content/images/_index.md

@@ -1,4 +1,19 @@
 +++
 title = "Images"
-weight = 80
 +++
+
+### [Annotate an image](annotate-an-image)
+`codefresh image <id>`
+
+Annotate an image
+
+### [Get a single image](get-a-single-image)
+`codefresh images [id]`
+
+Get a specific or an array of images
+
+### [Tag an image](tag-an-image)
+`codefresh tag <id> [tags..]`
+
+Add an image tag
+

docs-template/content/installation/download.md

@@ -9,9 +9,9 @@ Navigate to <a href="https://github.com/codefresh-io/cli/releases" target="_blan
 and download the binary that matches your operating system.<br>
 We currently support the following OS: <br>
 <ul>
-    <li><a href="https://github.com/codefresh-io/cli/releases/download/v0.6.6/codefresh-v0.6.6-linux-x64.tar.gz" target="_blank">Linux-x64</a></li>
-    <li><a href="https://github.com/codefresh-io/cli/releases/download/v0.6.6/codefresh-v0.6.6-macos-x64.tar.gz" target="_blank">Macos-x64</a></li>
-    <li><a href="https://github.com/codefresh-io/cli/releases/download/v0.6.6/codefresh-v0.6.6-win-x64.tar.gz" target="_blank">Windows-x64</a></li>
+    <li><a href="https://github.com/codefresh-io/cli/releases/download/v0.7.4/codefresh-v0.7.4-linux-x64.tar.gz" target="_blank">Linux-x64</a></li>
+    <li><a href="https://github.com/codefresh-io/cli/releases/download/v0.7.4/codefresh-v0.7.4-macos-x64.tar.gz" target="_blank">Macos-x64</a></li>
+    <li><a href="https://github.com/codefresh-io/cli/releases/download/v0.7.4/codefresh-v0.7.4-win-x64.tar.gz" target="_blank">Windows-x64</a></li>
 </ul> 
 
 After downloading the binary, untar or unzip it and your are good to go.<br>

docs-template/content/pipelines/Execute a pipeline.md

@@ -5,8 +5,7 @@ title = "Execute a pipeline"
 ### Command
 `codefresh run <id>`
 
-Run a pipeline and attach the created workflow logs.
-Returns an exist code according to the workflow finish status (Success: 0, Error: 1, Terminated: 2).
+Run a pipeline and attach the created workflow logs.<br />Returns an exit code according to the workflow finish status (Success: 0, Error: 1, Terminated: 2).
 ### Positionals
 
 Option | Default | Description
@@ -21,6 +20,5 @@ Option | Default | Description
 --no-cache |  | Ignore cached images
 --reset-volume |  | Reset pipeline cached volume
 --variable |  | Set build variables
---scale | 1 | todo
 --detach |  | Run pipeline and print build ID
 --variable-file |  | Set build variables from a file

docs-template/content/pipelines/_index.md

@@ -1,4 +1,19 @@
 +++
 title = "Pipelines"
-weight = 50
 +++
+
+### [Update a single pipeline](update-a-single-pipeline)
+`codefresh pipeline <id>`
+
+Apply changes to a pipeline
+
+### [Get a single pipeline](get-a-single-pipeline)
+`codefresh pipelines [id]`
+
+Get a specific or an array of pipelines
+
+### [Execute a pipeline](execute-a-pipeline)
+`codefresh run <id>`
+
+Run a pipeline and attach the created workflow logs.<br />Returns an exit code according to the workflow finish status (Success: 0, Error: 1, Terminated: 2).
+