diff --git a/docs/README.md b/docs/README.md index 586ac39ab..fdf0907e1 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,3 +1,5 @@ +
+ ![alt text](https://thumb.tildacdn.com/tild3162-6435-4365-a230-656137616436/-/resize/560x/-/format/webp/stacknlogo3.png) [](https://github.com/scaleoutsystems/stackn/actions/workflows/integration-tests.yaml) diff --git a/docs/_coverpage.md b/docs/_coverpage.md new file mode 100644 index 000000000..969c549bc --- /dev/null +++ b/docs/_coverpage.md @@ -0,0 +1,14 @@ + + +![logo](_media/icon.svg) + +# STACKn 0.7 + +> A lightweight, cloud-native machine learning platform + +[GitHub](https://github.com/scaleoutsystems/stackn) +[Get Started](#main-content) + + + +![color](#EBD886) \ No newline at end of file diff --git a/docs/_media/icon.svg b/docs/_media/icon.svg new file mode 100644 index 000000000..0f4e0ee31 --- /dev/null +++ b/docs/_media/icon.svg @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/docs/favicon.ico b/docs/favicon.ico new file mode 100644 index 000000000..1612a05a9 Binary files /dev/null and b/docs/favicon.ico differ diff --git a/docs/images/apps-from-overview.gif b/docs/images/apps-from-overview.gif index d963d1043..4b57e1ea8 100644 Binary files a/docs/images/apps-from-overview.gif and b/docs/images/apps-from-overview.gif differ diff --git a/docs/images/apps-from-side-panel.gif b/docs/images/apps-from-side-panel.gif index 4ee876076..9140cd722 100644 Binary files a/docs/images/apps-from-side-panel.gif and b/docs/images/apps-from-side-panel.gif differ diff --git a/docs/images/create-project.gif b/docs/images/create-project.gif index a9373d285..93bfe314e 100644 Binary files a/docs/images/create-project.gif and b/docs/images/create-project.gif differ diff --git a/docs/images/old_apps-from-overview.gif b/docs/images/old_apps-from-overview.gif new file mode 100644 index 000000000..d963d1043 Binary files /dev/null and b/docs/images/old_apps-from-overview.gif differ diff --git a/docs/images/old_apps-from-side-panel.gif b/docs/images/old_apps-from-side-panel.gif new file mode 100644 index 000000000..4ee876076 Binary files /dev/null and b/docs/images/old_apps-from-side-panel.gif differ diff --git a/docs/images/old_create-project.gif b/docs/images/old_create-project.gif new file mode 100644 index 000000000..a9373d285 Binary files /dev/null and b/docs/images/old_create-project.gif differ diff --git a/docs/images/old_project-overview.gif b/docs/images/old_project-overview.gif new file mode 100644 index 000000000..85357412f Binary files /dev/null and b/docs/images/old_project-overview.gif differ diff --git a/docs/images/project-overview.gif b/docs/images/project-overview.gif index 85357412f..f8330069b 100644 Binary files a/docs/images/project-overview.gif and b/docs/images/project-overview.gif differ diff --git a/docs/index.html b/docs/index.html index 2d79df369..9bce25a1d 100644 --- a/docs/index.html +++ b/docs/index.html @@ -7,6 +7,9 @@ + + +
@@ -14,10 +17,25 @@ window.$docsify = { name: '', repo: '', - themeColor: '#3F51B5', - loadNavbar: true + themeColor: '#191919', + loadNavbar: true, + coverpage: true } + + diff --git a/docs/tutorial.md b/docs/tutorial.md index 892275284..3db5060aa 100644 --- a/docs/tutorial.md +++ b/docs/tutorial.md @@ -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. + - **_Settings_:** the tab where a user can access the current project settings ![screen-gif](images/project-overview.gif) @@ -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: