Marina Konstantinova 4 lat temu
rodzic
commit
1849699a81

Plik diff jest za duży
+ 0 - 165
docs/docs/01-m-overview.md


+ 0 - 21
docs/docs/02-m-download-install.md

@@ -1,21 +0,0 @@
----
-id: 02-m-download-install
-title: Download and install
-sidebar_label: Download and install
----
-
-In order to get the tool working, [dowload the archive](https://github.com/metrixplusplus/metrixplusplus/releases) with the latest stable version and unpack it to some folder. The first run of the tool will trigger the installation within the folder, where it was launched.
-
-In order to checkout the latest development version from the [version control system](https://github.com/metrixplusplus/metrixplusplus) use this command:
-```sh
-> git clone https://github.com/metrixplusplus/metrixplusplus metrixplusplus
-```
-
-#### Change and Release Notes
-Change and release notes are available [here](https://github.com/metrixplusplus/metrixplusplus/blob/master/CHANGELOG.md).
-
-#### Prerequisites
-Python Runtime Environment (version 2.8.x or 3.x)
-
-#### License
-[MIT license](https://github.com/metrixplusplus/metrixplusplus/blob/master/LICENSE)

+ 0 - 26
docs/docs/03-m-getting-started.md

@@ -1,26 +0,0 @@
----
-id: 03-m-getting-started
-title: Getting started
-sidebar_label: Getting started
----
-
-The tool is relatively simple to use. There are 3 fundamental steps:
-
-* Collect the data, for example:
-```bash
-> python "/path/to/metrix++.py" collect --std.code.lines.code --std.code.complexity.cyclomatic
-```
-
-
-* View the data, for example:
-```bash
-> python "/path/to/metrix++.py" view
-```
-
-
-* Apply thresholds, for example:
-```bash
-> python "/path/to/metrix++.py" limit --max-limit=std.code.complexity:cyclomatic:7
-```
-
-Please, check the advanced [description of the workflow](04-m-workflow.md) with real examples.

Plik diff jest za duży
+ 0 - 506
docs/docs/04-m-workflow.md


Plik diff jest za duży
+ 0 - 642
docs/docs/05-m-extending-tool.md


+ 0 - 16
docs/docs/06-m-feeback-contribute.md

@@ -1,16 +0,0 @@
----
-id: 06-m-feeback-contribute
-title: Feeback and contribute
-sidebar_label: Feeback and contribute
----
-Now it is your turn. There are multiple ways how you can contribute and help to improve and progress Metrix++ project:
-
-* Try Metrix++ and [post review](https://github.com/metrixplusplus/metrixplusplus/issues/new)
-* [Submit new feature request or bug report](https://github.com/metrixplusplus/metrixplusplus/issues/new)
-* [Ask a question](https://github.com/metrixplusplus/metrixplusplus/issues/new)
-* Submit git pull request
-* Create and publish your plugin. [Request to refer](https://github.com/metrixplusplus/metrixplusplus/issues/new) to it from Metrix++ project space.
-* [Submit your plugin](https://github.com/metrixplusplus/metrixplusplus/issues/new) to include to the standard set
-* ... and consider to 
-<a href="mailto:avkonst@gmail.com?subject=Metrix%2B%2B Join Request" target="blank">join the project</a>
-!

+ 2 - 2
docs/docusaurus.config.js

@@ -14,7 +14,7 @@ module.exports = {
       },
       links: [
         {
-          to: 'docs/01-m-overview',
+          to: 'docs/01-u-overview',
           activeBasePath: 'docs',
           label: 'Docs',
           position: 'left',
@@ -35,7 +35,7 @@ module.exports = {
           items: [
             {
               label: 'Users Manual',
-              to: 'docs/01-m-overview',
+              to: 'docs/01-u-overview',
             },
             {
               label: 'Developers Manual',

+ 6 - 6
docs/sidebars.js

@@ -1,12 +1,12 @@
 module.exports = {
   someSidebar: {
     'Users Manual': [
-        '01-m-overview',
-        '02-m-download-install',
-        '03-m-getting-started',
-        '04-m-workflow',
-        '05-m-extending-tool',
-        '06-m-feeback-contribute'
+        '01-u-overview',
+        '02-u-download-install',
+        '03-u-getting-started',
+        '04-u-workflow',
+        '05-u-extending-tool',
+        '06-u-feeback-contribute'
     ],
     'Developers Manual': [
         '01-d-file'

+ 1 - 1
docs/src/pages/index.js

@@ -101,7 +101,7 @@ function Home() {
                 'button button--outline button--secondary button--lg',
                 styles.getStarted,
               )}
-              to={useBaseUrl('docs/01-m-overview')}>
+              to={useBaseUrl('docs/01-u-overview')}>
               Get Started
             </Link>
           </div>