Commit b45d3f50 authored by Kevin Di Lallo's avatar Kevin Di Lallo
Browse files

added linter doc 

minor doc update

minor doc update

meep-ctrl-engine import fix
parent 9f5aa481

.golangci.yml

+1 −5
Original line number Diff line number Diff line
@@ -32,7 +32,3 @@ linters: 
        # - unparam

        - unused

        - varcheck
 
 No newline at end of file
 


linters-settings:

    goimports:

        write: true
 
 No newline at end of file

README.md

+1 −1
Original line number Diff line number Diff line
@@ -46,7 +46,7 @@ Before getting started we recommend familiarity with key [AdvantEDGE concepts](d 


## Building



- [Setup development environment (Ubuntu/Go/Node.js/NPM)](docs/setup_dev.md)

- [Setup development environment (Ubuntu/Go/Node.js/NPM/Linters)](docs/setup_dev.md)



- Clone the AdvantEDGE repo<br>

  `git clone https://github.com/<your-fork>/AdvantEDGE.git`<br>

docs/build.md

+6 −0
Original line number Diff line number Diff line
@@ -25,8 +25,14 @@ The [_meepctl CLI tool_](meepctl/meepctl.md) is used to build the AdvantEDGE bin 


```

meepctl build all



# To build a single micro-service:

# meepctl build <micro-service name>

```



>**NOTE**<br>

Linters are run by default on every build. To disable linting use the `--nolint` flag.



This command generates the _core_ micro-service binaries, as well as the frontend web application.



To deploy the new binaries, follow the [Deploy AdvantEDGE](deploy.md) procedure.

docs/meepctl/meepctl.md

+1 −1
Original line number Diff line number Diff line
@@ -30,4 +30,4 @@ meepctl - CLI application to control the AdvantEDGE platform 
* [meepctl test](meepctl_test.md)	 - Generate code coverage report

* [meepctl version](meepctl_version.md)	 - Display version information



###### Auto generated by spf13/cobra on 22-Apr-2019
 
###### Auto generated by spf13/cobra on 30-Apr-2019

docs/meepctl/meepctl_build.md

+2 −1
Original line number Diff line number Diff line
@@ -40,6 +40,7 @@ meepctl build <target> [flags] 
```

      --codecov   Build a code coverage binary (dev. option)

  -h, --help      help for build

      --nolint    Disable linting

```



### Options inherited from parent commands
@@ -53,4 +54,4 @@ meepctl build <target> [flags] 


* [meepctl](meepctl.md)	 - meepctl - CLI application to control the AdvantEDGE platform



###### Auto generated by spf13/cobra on 22-Apr-2019
 
###### Auto generated by spf13/cobra on 30-Apr-2019