Merge pull request #2 from restcli/update_docs

Update docs

Author: quangson91

.gitignore

@@ -117,3 +117,5 @@ dist
 
 .docusaurus/
 build/
+
+.idea/

docs/about.md

@@ -2,6 +2,29 @@
 id: about
 title: About
 sidebar_label: About
+slug: /
 ---
 
-### About
+A missing commandline application for execute IntelliJ HTTP Client file.
+
+** Features **
+
+* Written by Kotlin 🤩
+* Execute Intellij HTTP request files
+* Running test script including:
+    - Embedded script inside HTTP request file
+    - Include external javascript test file
+* Loading and inject environment variables from
+    - http-client.env.json
+    - http-client.private.env.json
+* Cross platform 💻🖥️
+  - Windows, macOS and Linux ready.
+* Beautiful request log 🤑🤑🤑
+  - Request & response detail
+  - Test result table  
+* Easy to custom via commandline arguments 😎
+  - Custom logging request
+  - Inject environment name
+* [Generate test report - junit format.](https://github.com/quangson91/demo_intellij_rest_cli) 🥰🥰🥰
+* [Support setNextRequest. So you can custom flexbile the test flow](https://github.com/quangson91/intellij_rest_cli/releases/tag/v1.5) ✨✨✨
+

docs/features.md

@@ -4,10 +4,15 @@ title: Features
 sidebar_label: Features
 ---
 
-## Features
+### Show detail request/response including test result
 
-### Feature 1
+![request-with-test-success](/img/request-with-test-success.png)
+![request-with-test-failed](/img/request-with-test-failed.png)
 
-### Feature 2
+### Test result table
 
-### Feature 3
+![test-result-table](/img/test-result-table.png)
+
+### Generate junit test report (xml) that can be viewed by other tools such as xunit-viewer
+
+![generate-junit-test-report](/img/generate-junit-test-report.png)

docs/gitlab-pipeline-integration.md

@@ -3,4 +3,5 @@ id: gitlab-pipeline-integration
 title: Gitlab pipeline
 ---
 
+# TODO
 Using rest-cli in gitlab pipeline

docs/how-to-use.md

@@ -0,0 +1,33 @@
+---
+id: how-to-use
+title: How to use
+sidebar_label: How to use
+---
+
+```
+Usage: rest-cli [-hV] [-e=<environmentName>] [-l=<logLevel>]
+                [-r=<testReportNames>] FILES...
+IntelliJ RestCli
+      FILES...    Path to one ore more http script files.
+  -e, --env=<environmentName>
+                  Name of the environment in config file
+                  (http-client.env.json/http-client.private.env.json).
+  -h, --help      Show this help message and exit.
+  -l, --log-level=<logLevel>
+                  Config log level while the executor running.
+                  Valid values: NONE, BASIC, HEADERS, BODY
+  -r, --report-names=<testReportNames>
+                  Custom test report names inside folder "test-reports".
+                  The report names must separate by ':' character;
+                  If the split string of the report name is empty, then the
+                    test request file name will
+                  be used for report name
+                  Such as:
+                  java -jar restcli.jar -r custom_report1::custom_report3 test1.
+                    http test2.http test3.http
+                  Then the test report for test1.http will be custom_report1.xml
+                  test2.http -> test2.xml (Because the report name for test2.
+                    http is empty)
+                  test3.http -> custom_report3.xml
+  -V, --version   Print version information and exit.
+```

docs/jenkins-integration.md

@@ -3,4 +3,5 @@ id: jenkins-ci-integration
 title: Jenkins CI
 ---
 
+# TODO
 Using rest-cli in jenkins

docs/roadmap.md

@@ -1,7 +1,10 @@
 ---
 id: roadmap
-title: Intro
-sidebar_label: Intro
+title: Roadmap
+sidebar_label: Roadmap
 ---
 
 ### Roadmap
+- Build docker image.
+- Support install via home-brew.
+- Add docs for integrates with CI tools such as: jenkins, travis, gitlab ci.

docs/travisci-integration.md

@@ -3,4 +3,5 @@ id: travis-integration
 title: Travis CI
 ---
 
+# TODO
 Using rest-cli in Travis CI

docusaurus.config.js

@@ -38,8 +38,6 @@ module.exports = {
       '@docusaurus/preset-classic',
       {
         docs: {
-          // It is recommended to set document id as docs home page (`docs/` path).
-          homePageId: 'about',
           sidebarPath: require.resolve('./sidebars.js'),
           // Please change this to your repo.
           editUrl:

sidebars.js

@@ -9,13 +9,12 @@ module.exports = {
       id: 'features',
     },
     {
-      type: 'category',
-      label: 'CI Integration',
-      items: [
-        'gitlab-pipeline-integration',
-        'jenkins-ci-integration',
-        'travis-integration',
-      ],
+      type: 'doc',
+      id: 'how-to-use',
+    },
+    {
+      type: 'doc',
+      id: 'roadmap',
     },
   ],
 };