Hi guys! As discussed in the other threads, we will improve our
documentation.

I created an issue on ReadTheDocs setup:
https://issues.apache.org/jira/projects/MARVIN/issues/MARVIN-76
We need someone with access to the infrastructure to do some of this work.

I also made a sketch of a new documentation structure. We can discuss these
points and then, it will be open to contributions. We will split the topics
between contributors who are comfortable to write about it, this is a good
first issue as well. A lot of this points are already documented, so we
only need to improve a bit.

Installation:
   - Linux;
   - Mac.
Basic Usage:
   - Toolbox Commands;
   - Iris Example;
   - DASFE;
   - Unit testing.
Serializers:
   - KerasSerializer;
   - How to make a custom serializer.
Engine:
   - engine.metadata;
   - engine.messages;
   - engine.params;
   - feedback.messages;
Engine Executor:
   - EE Features;
   - Remote artifact persistence:
       - File System;
       - HDFS;
       - Azure;
       - AmazonS3;
Spark:
   - Spark Example
Developer guide

Any suggestions?

Best regards,
Lucas Cardoso

Reply via email to