Skip to content
This repository has been archived by the owner on Apr 21, 2023. It is now read-only.

doc_restructuring incl. [SPOT-163] #50

Merged
merged 3 commits into from
Jun 9, 2017

Conversation

NathanSegerlind
Copy link
Contributor

updated documentation, added separate sections for the data schema, the jar, and the ml_ops.sh script

updated documentation, added separate sections for the data schema, the jar, and the ml_ops.sh script
Copy link

@rabarona rabarona left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the structure and the new content.
There are still a few things missing like the ones mentioned in SPOT-163 https://issues.apache.org/jira/browse/SPOT-163 and all the stuff in spot.conf regarding spot-ml.

I'm not saying this PR should resolve those, I'm just complementing the list.

Thanks.

@NathanSegerlind
Copy link
Contributor Author

NathanSegerlind commented Jun 9, 2017

I'll add some material to address SPOT-163

but what we probably really need somewhere is a "hey to configure your /etc/spot.conf" document

added documentation on the parameters that ml_ops.sh grabs from /etc/spot.conf
@NathanSegerlind NathanSegerlind changed the title doc_restructuring doc_restructuring incl. [SPOT-163] Jun 9, 2017
Added documentation for how ml_ops.sh used the TOL parameter from /etc/spot.conf as a default value for the suspicion threshold.
Copy link

@rabarona rabarona left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks.

@lujacab
Copy link

lujacab commented Jun 9, 2017

+1

1 similar comment
@raypanduro
Copy link
Contributor

+1

@asfgit asfgit merged commit 283493c into apache:master Jun 9, 2017

The remaining instructions in this README file treat spot-ml in a stand-alone fashion that might be helpful for customizing and troubleshooting the
component.
These routines are contained in a jar file and there is a shell script ml_ops.sh for a simplified the invocation of the analyses.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There seems to be a typo here on new line 10, "...for a simplified the invocation..."

@brandon-edwards
Copy link
Contributor

+1 (one type pointed out)

@brandon-edwards
Copy link
Contributor

'typo' that is

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
6 participants