Add getting started tutorial

Signed-off-by: Keshav Priyadarshi <git@keshav.space>

Author: keshav-space

docs/source/img/tutorial_getting_started_admin.jpg

@@ -20,6 +20,12 @@ you will find information on:
     contributing
     changelog
 
+.. toctree::
+    :maxdepth: 2
+    :caption: Tutorial
+
+    tutorial_getting_started
+
 .. toctree::
     :maxdepth: 2
     :caption: Reference Documentation

docs/source/img/tutorial_getting_started_repo_add.jpg

@@ -0,0 +1,77 @@
+.. _tutorial_getting_started:
+
+Getting Started
+===============
+
+In this tutorial, we will guide you through the step-by-step process of getting started with syncing
+and federating package metadata.
+
+.. note::
+    This tutorial assumes that you have a working installation of FederatedCode.
+    If you don't, please refer to the :ref:`installation` page.
+
+Create Admin User
+-----------------
+
+.. code-block:: bash
+
+    python manage.py createsuperuser
+
+Log in to FederatedCode Admin
+------------------------------
+
+Navigate to http://127.0.0.1:8000/admin/ and log in using the credentials created in the previous step.
+
+.. image:: img/tutorial_getting_started_admin.jpg
+
+Create Service User
+-------------------
+
+Go to http://127.0.0.1:8000/admin/fedcode/service/add/ and create a service. Select the newly created superuser as the user, and leave the "remote-actor" field empty.
+
+.. image:: img/tutorial_getting_started_service_creation.jpg
+
+Clone the FederatedCode Data Repository
+---------------------------------------
+
+Visit https://github.com/aboutcode-org/aboutcode-packages-npm-385 and clone the repository.
+
+Add Data Repository in FederatedCode
+-------------------------------------
+
+Go to http://127.0.0.1:8000/create-repo and add the repository URL: https://github.com/<YOUR-USER-NAME>/aboutcode-packages-npm-385
+
+.. image:: img/tutorial_getting_started_repo_add.jpg
+
+Sync Package Scan
+-----------------
+
+Run the following command to sync the scan metadata from the FederatedCode Git repository
+
+.. code-block:: bash
+
+    python manage.py sync sync_scancode_scans
+
+Federate Package Activity
+-------------------------
+
+Run the following command to send activity updates to existing subscribers of the package
+
+.. code-block:: bash
+
+    python manage.py federate
+
+Click on `Packages` link
+--------------------------
+
+.. image:: img/tutorial_getting_started_step_packages.jpg
+
+Click on any PURL link
+----------------------
+
+.. image:: img/tutorial_getting_started_step_package_list.jpg
+
+Package Activity
+----------------
+
+.. image:: img/tutorial_getting_started_step_package_activity.jpg