Skip to content
This repository has been archived by the owner on Mar 17, 2024. It is now read-only.

Feature/SK-403 | Update docs #319

Open
wants to merge 1 commit into
base: release/v0.7.0
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<div id="main-content"></div>

![alt text](https://thumb.tildacdn.com/tild3162-6435-4365-a230-656137616436/-/resize/560x/-/format/webp/stacknlogo3.png)

[<img src="https://github.com/scaleoutsystems/stackn/actions/workflows/integration-tests.yaml/badge.svg">](https://github.com/scaleoutsystems/stackn/actions/workflows/integration-tests.yaml)
Expand Down
14 changes: 14 additions & 0 deletions docs/_coverpage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<!-- _coverpage.md -->

![logo](_media/icon.svg)

# STACKn <small>0.7</small>

> A lightweight, cloud-native machine learning platform

[GitHub](https://github.com/scaleoutsystems/stackn)
[Get Started](#main-content)

<!-- background color -->

![color](#EBD886)
13 changes: 13 additions & 0 deletions docs/_media/icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/favicon.ico
Binary file not shown.
Binary file modified docs/images/apps-from-overview.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/apps-from-side-panel.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/create-project.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/old_apps-from-overview.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/old_apps-from-side-panel.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/old_create-project.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/old_project-overview.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/project-overview.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 20 additions & 2 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,35 @@
<meta name="description" content="Description">
<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/lib/themes/vue.css">
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link href="https://fonts.googleapis.com/css2?family=Manrope&display=swap" rel="stylesheet">
</head>
<body>
<div id="app"></div>
<script>
window.$docsify = {
name: '',
repo: '',
themeColor: '#3F51B5',
loadNavbar: true
themeColor: '#191919',
loadNavbar: true,
coverpage: true
}
</script>
<script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>

<style>

body {

font-family: 'Manrope', sans-serif;
}


main{
width: 100%;
}

</style>
</body>
</html>
13 changes: 6 additions & 7 deletions docs/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,23 @@
## Create a Project
To get up and running with STACKn, start by creating a new Project template following the steps below:

1. Click on the blue `+ New project` button in the top right corner.
1. Click on the `+ New project` button in the top right corner.
2. Select one of the available project templates by clicking on the `Create` button.
3. Enter the project name (which is mandatory). You can still change the project template at this stage from the dedicated dropdown menu. The project description is optional.
4. Finally, click on the blue `Create project` button.
4. Finally, click on the `Create project` button.

![screen-gif](images/create-project.gif)

## Project Overview
Once you have created a project, you can find it under the general tab called _Projects_. Here you will find the list of all your created projects. To get an overview of one of your project, click on the `Open` button.

You will land on the project dashboard page, also called as the `Overview`. On the left side menu you can navigate through the various components/resources categories available within a STACKn project:
- **_Objects_:** a list of model objects created under the current project
- **_Compute_:** a series of components to be used for experimentation and training models with pre-configured data science environments.
You will land on the project dashboard page, also called the `Overview`. On the left side menu you can navigate through the various components/resources categories available within a STACKn project:
- **_Models_:** a list of model objects created under the current project
- **_Notebooks_:** a series of components to be used for experimentation and training models with pre-configured data science environments.
- **_Serve_:** the most common ML serving applications used for deploying your trained models
- **_Store_:** project storage volumes, kubernetes persistent volume, object stores and databases for storing and sharing datasets.
- **_Develop_:** standard developing IDE such as VisualStudio together with dedicate tools for the machine learning lifecycle .
- [**_FEDn_:**](https://scaleoutsystems.github.io/fedn/) an open-source, modular and model agnostic framework for Federated Machine Learning. Scale seamlessly from pseudo-distributed development to real-world production networks in distributed, heterogeneous environments.
<!-- - [**_FEDn_:**](https://scaleoutsystems.github.io/fedn/) an open-source, modular and model agnostic framework for Federated Machine Learning. Scale seamlessly from pseudo-distributed development to real-world production networks in distributed, heterogeneous environments. -->
- **_Settings_:** the tab where a user can access the current project settings

![screen-gif](images/project-overview.gif)
Expand All @@ -35,7 +35,6 @@ Alternatively you can create components by first selecting one of the components

![screen-gif](images/apps-from-side-panel.gif)


## Settings
The `Settings` page contains all the information about your Project and its components. Some
of the things you can do there are:
Expand Down