Skip to content

Commit

Permalink
Docs/SK-1173 | Quickstart guide updated with the Packages link in the…
Browse files Browse the repository at this point in the history
… studio (#738)
  • Loading branch information
sztoor authored Nov 5, 2024
1 parent 49043f8 commit 919edcf
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 5 deletions.
Binary file modified docs/img/upload_package.png
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/img/upload_seed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
27 changes: 22 additions & 5 deletions docs/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -130,13 +130,30 @@ Next will now upload these files to your Studio project.
------------------------------
The next step is to initialize the server side with the client code and the initial global model. In the Studio UI,

#. Navigate to the project you created in step 1 and click on the "Sessions" tab.
#. Click on the "New Session" button.
#. Under the "Compute package" tab, select a name and upload the generated package file.
#. Under the "Seed model" tab, upload the generated seed file:
**Upload the compute package**

#. Navigate to the project you created in step 1 and click on the "Packages" link.
#. Click on the "Add Package" button.
#. On the next form, enter a name and upload the generated package file.

.. note::
On the "packages" link, you can also select the option "Use local package mode". This is an advanced option that
allows each client to connect with their own custom compute package. The option can also be beneficial when
developing your own project, as it eliminates the need to upload a new package with every change or version update.

.. image:: img/upload_package.png

**Upload the seed model**

#. Navigate to the project you created in step 1 and click on the “Sessions” tab.
#. Click on the “New Session” button.
#. Under the “Seed model” tab, upload the generated seed file:

.. image:: img/upload_seed.png

.. note::
You can upload multiple compute packages and seed models, and select the one needed for different sessions.

Continue to step 4 before starting the session. The uploaded package and seed files are saved.

4. Start clients
Expand Down Expand Up @@ -253,4 +270,4 @@ to learn how to set up an all-in-one development environment using Docker and do
:og:description: This tutorial is a quickstart guide to FEDn based on a pre-made FEDn Project. It is designed to serve as a starting point for new developers.
:og:image: https://fedn.scaleoutsystems.com/static/images/scaleout_black.png
:og:url: https://fedn.scaleoutsystems.com/docs/quickstart.html
:og:type: website
:og:type: website

0 comments on commit 919edcf

Please sign in to comment.