tmp

docs/source/conf.py

@@ -53,9 +53,7 @@
 <hr/><br/>
 
 <a class='external' href='https://github.com/eduNEXT/picasso' target='_blank'>About the
-project in Github:</a><br/>
-
-
+project in Github</a><br/>
 """
 
 html_theme_options = {

docs/source/configurations.rst → docs/source/how_tos/configurations.rst

@@ -18,11 +18,7 @@ Inputs are the parameters that you can set to customize the behavior of the Pica
 
 These inputs can be set in the workflow file that calls the Picasso workflow using the ``with`` keyword, by manually setting them in the workflow file, or by using the ``workflow_dispatch`` event. For more details on how to set input values in Github Actions, please refer to the `Workflow syntax for GitHub Actions`_ documentation.
 
-.. `Workflow syntax for GitHub Actions`: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
-
-These inputs can be set in the workflow file that calls the Picasso workflow using the ``with`` keyword, by manually setting them in the workflow file, or by using the ``workflow_dispatch`` event. For more details on how to set input values in Github Actions, please refer to the `Workflow syntax for GitHub Actions`_ documentation.
-
-.. `Workflow syntax for GitHub Actions`: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
+.. _`Workflow syntax for GitHub Actions`: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
 
 Here is an example of how to use the Picasso workflow with the inputs set:
 
@@ -59,10 +55,6 @@ To correctly use Docker Hub or AWS registries to push images, you should set the
 
 .. _`Using secrets in GitHub Actions`: https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions
 
-These variables should be set in the Github Actions repository's secrets settings. For more information on how to set secrets in Github, please refer to the `Using secrets in GitHub Actions`_ documentation.
-
-.. _`Using secrets in GitHub Actions`: https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions
-
 Here is an example of how to use the Picasso workflow with the inputs and secrets set:
 
 .. code-block:: yaml

docs/configuring_docker_registries.rst → docs/source/how_tos/configuring_docker_registries.rst

@@ -9,7 +9,10 @@ To allow further customization in the build process, Picasso Workflow also suppo
 2. Setting the corresponding secrets in the Github Actions repository's secrets settings. If you're using Docker Hub, you should set the ``DOCKERHUB_USERNAME`` and ``DOCKERHUB_PASSWORD`` secrets. If you're using AWS ECR, you should set the ``AWS_ACCESS_KEY_ID``, ``AWS_SECRET_ACCESS_KEY``, and ``AWS_REGION`` secrets.
 3. Using the Picasso Workflow with the inputs and secrets set.
 
-Here is an example of how to configure the Docker registries in the ``config.yml`` file:
+AWS ECR registry
+================
+
+Here is an example of how to configure the Docker registries in the ``config.yml`` file to use the AWS ECR registry:
 
 .. code-block:: yaml
 

docs/source/index.rst

@@ -7,10 +7,11 @@ Here, you will find details on how to use and configure Picasso Workflow in your
 
 .. _tutor-contrib-picasso: https://github.com/eduNEXT/tutor-contrib-picasso/
 
-Contents
-********
+.. toctree::
+    :maxdepth: 2
+    :caption: Contents
 
-- `Configurations <configurations.rst>`_
-- `Workflow Usage <reuse_workflow.rst>`_
-- `Configuring Docker Registries <configuring_docker_registries.rst>`_
-- `Triggering a Build with the GitHub cli <trigger_build_with_cli.rst>`_
+    quickstart
+    topic-guides/index
+    how-tos/index
+    tutorials/index

docs/source/tutorials/index.rst

@@ -0,0 +1,11 @@
+Tutorials
+#########
+
+This page contains a list of tutorials that will help you get started with Picasso Workflow.
+
+.. toctree::
+    :maxdepth: 2
+    :caption: Contents
+
+    reuse_workflow
+    trigger_build_with_cli

docs/source/reuse_workflow.rst → docs/source/tutorials/reuse_workflow.rst

@@ -1,7 +1,7 @@
 Reusing the Picasso Workflow
 ###################################
 
-This document will guide you through different ways of reusing the Picasso workflow.
+This document will guide you through different ways of reusing the Picasso workflow in your own repository.
 
 To use a reusable workflow from your own repository, you can use the ``uses`` keyword in your workflow file. The ``uses`` keyword specifies the location of the reusable workflow file, which can be a specific tag, branch, or commit, either in the same repository or a different repository.
 
@@ -11,6 +11,9 @@ For more information, see `Reusing workflows`_.
 
 .. _`Reusing workflows`: https://docs.github.com/en/actions/sharing-automations/reusing-workflows
 
+Workflow Dispatch Event
+=======================
+
 Here is an example of how to use the Picasso workflow using the `workflow_dispatch`_ event:
 
 .. code-block:: yaml
@@ -60,6 +63,9 @@ Here is an example of how to use the Picasso workflow using the `workflow_dispat
 
 In this example, you can trigger the workflow manually via the GitHub Actions tab, using the ``workflow_dispatch`` feature to input the necessary values. Based on the provided inputs, the workflow will then build the Open edX image.
 
+Push Event
+==========
+
 Here's an example of how to use the Picasso workflow using the `push`_ event:
 
 .. code-block:: yaml