[micro-mordred] Add tutorial for exectution of Micro-Mordred via #87
Conversation
|
@valeriocos Ping :) |
sirmordred/micro-mordred.md
Outdated
| <p><b>Browser: Kibiter Instance</b></p> | ||
| </div> | ||
|
|
||
| 3. We need to create and Index Pattern before we move further, but as you can see on the `Kibiter Instance` above, it say `Couldn't find any Elasticsearch data. You'll need to index some data into Elasticsearch before you can create an index pattern`. Hence, in order to do that, we'll now execute mirco-mordred using the following command, which will execute the `Raw` and `Enrich` tasks for the Git config section from the provided `setup.cfg` file. |
There was a problem hiding this comment.
The beginning of the paragraph can be confusing for a reader, a possible alternative could be:
As you can see on the `Kibiter Instance` above, it say `Couldn't find any Elasticsearch data. You'll need to index
some data into Elasticsearch before you can create an index pattern`. Hence, in order to index some data, we'll
now execute micro-mordred using the following command, which will call the `Raw` and `Enrich` tasks for the
Git config section from the provided `setup.cfg` file.
There was a problem hiding this comment.
Sorry for the confusion. I'll make sure to avoid such in the future.
Thanks for a reference alternative :)
sirmordred/micro-mordred.md
Outdated
|
|
||
| We'll (for the purpose of this tutorial) use the files provided in the `/utils` directory, but feel free to play around with the file and their configurations :) | ||
|
|
||
| - **Note**: In case the process fails to index the data to the ElasticSearch, check the `.perceval` folder in the home directory; which in this case may contain same repositories as mentioned in the `projects.json` file. |
There was a problem hiding this comment.
It could be useful to add also the action to take: rm -rf .perceval/repositories/...
There was a problem hiding this comment.
Yes. That would be helpful.
Thanks!
sirmordred/micro-mordred.md
Outdated
| 3. We need to create and Index Pattern before we move further, but as you can see on the `Kibiter Instance` above, it say `Couldn't find any Elasticsearch data. You'll need to index some data into Elasticsearch before you can create an index pattern`. Hence, in order to do that, we'll now execute mirco-mordred using the following command, which will execute the `Raw` and `Enrich` tasks for the Git config section from the provided `setup.cfg` file. | ||
|
|
||
| ``` | ||
| $ python3 micro.py --raw --enrich setup.cfg --backends git github |
sirmordred/micro-mordred.md
Outdated
|
|
||
| - **Note**: In case the process fails to index the data to the ElasticSearch, check the `.perceval` folder in the home directory; which in this case may contain same repositories as mentioned in the `projects.json` file. | ||
|
|
||
| 4. Now we can create index pattern and on it's successful creation we can analyzer the data as per fields. Now, we execute the `panels` task to load the corresponding `sigils panels` to Kibiter instance using the following command. |
There was a problem hiding this comment.
There are some typos in this sentence:
missing comma after Now
index pattern-> the index pattern
it's-> its
analyzer -> analyze
The sentence could be rewritten as follows:
Now, we can create the index pattern, and after its successful creation we can analyze the data as per fields.
Then, we can execute the `panels` task to load the corresponding `sigils panels` to Kibiter via the
following command.
There was a problem hiding this comment.
Thanks for pointing these out!.
I'll make the changes.
sirmordred/micro-mordred.md
Outdated
| $ python3 micro.py --panels --cfg setup.cfg | ||
| ``` | ||
|
|
||
| On successful execution of the above command, we can manage to produce some dashboard similar to the one shown below - |
There was a problem hiding this comment.
Missing full stop at the end of the sentence
sirmordred/micro-mordred.md
Outdated
| <p><b>Dashboard - Git: Areas of Code </b></p> | ||
| </div> | ||
|
|
||
| - Hence, we have successfully executed micro-mordred with the help of docker-compose |
Docker-Compose Signed-off-by: inishchith <inishchith@gmail.com>
|
@valeriocos Thanks a lot! for the review. |
|
@jgbarah @valeriocos Can you have a look at this. Thanks! |
There was a problem hiding this comment.
Thanks!
@valeriocos: ready to merge, from your point of view?
@valeriocos @jgbarah Please do let me know if any section needs more elaboration :)
Fixes: #84
Signed-off-by: inishchith inishchith@gmail.com