[SUBMARINE-921] [User] Refactor User docs

• Type: Sub-task
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 0.7.0
• Labels: pull-request-available
• Assignee: Byron Hsu
• Reporter: Byron Hsu
• Created: 12/Jul/21 02:37
• Updated: 12/Jul/21 05:17
• Resolved: 12/Jul/21 05:17

Description

Changes

Old:

.
└── Users Docs/
    ├── Submarine on Kubernetes/
    │   └── ...
    ├── Submarine on Yarn/
    │   └── ...
    ├── Submarine SDK/
    │   └── ...
    └── Submarine Security/
        └── ...

New:

.
└── Users Docs/
    ├── API documentation/
    │   ├── Experiment REST API
    │   ├── Experiment Template REST API
    │   ├── Environment REST API
    │   └── Notebook REST API
    └── Submarine SDK/
        ├── Experiment Client
        ├── Model Client
        └── Tracking (deprecated)
    ├── Submarine Security/
    │   └── ...
    └── Other utilities/
        └── MLflow UI
        └── Tensorboard

Details

1. Remove "Submarine on Yarn" because Yarn is deprecated.
2. Rename "Submarine on Kubernetes" to "API "documentation", categorized into four classes: "Experiment REST API", "Experiment Template REST API", "Environment REST API", and "Notebook REST API". For each API endpoint, provide spec and examples. (refer to https://docs.github.com/en/rest/reference/actions)
3. Refactor "Submarine-SDK", categorized into three classes: "Experiment Client", "Model Client" and "Tracking". For each class, provide the spec and examples. (refer to https://mlflow.org/docs/latest/python_api/mlflow.html)
4. Add "Other utilities" to provide the details of how to use tensorboard and mlflow UI.
5. Keep "Submarine Security" intact.

Issue Links

• links to: GitHub Pull Request #662