Merge pull request #282 from fabric-testbed/281-re-organize-start-her…

…e-and-update-readme

281 re organize start here and update readme

.github/workflows/checks.yml

@@ -0,0 +1,35 @@
+# Run some code checks with GitHub Actions.
+
+name: Code checks
+
+on:
+  push:
+    branches:
+      - "main"
+  pull_request:
+  pull_request_target:
+
+permissions:
+  contents: read
+  # Allow 1Password/check-signed-commits-action to leave comments on
+  # pull requests.
+  pull-requests: write
+
+jobs:
+
+  checks:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out sources
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0 # since we need to diff against origin/main.
+
+      # https://github.com/marketplace/actions/check-signed-commits-in-pr
+      # runs on pull_request_target and pull_request events, but
+      # pull_request_target is preferred because of the ability to
+      # leave comments on external PRs created from forks.
+      - name: Check that commits are signed
+        if: github.event_name == 'pull_request' || github.event_name == 'pull_request_target'
+        uses: 1Password/check-signed-commits-action@v1
+

CONTRIBUTING.md

@@ -0,0 +1,20 @@
+# Contributing to Jupyter Examples
+
+We invite contributions from the community to enrich and broaden the collection of Jupyter Notebook examples. If you have an example or tutorial you'd like to contribute, kindly follow these steps:
+
+- Fork the repository.
+- Create a new branch dedicated to your feature or fix.
+- Develop and thoroughly test your changes locally.
+- Commit your changes with clear and descriptive commit messages. Please ensure to use signed commits.
+- Push your changes to your fork.
+- Open a pull request against the main branch of the [repository].
+
+- Please make sure that your contributions align with the overarching goals and guidelines of the Fabric Testbed project.
+
+## Submitting Issues
+
+If you wish to propose new examples or report any issues, please submit an issue via GitHub. If you encounter a bug, kindly describe it in sufficient detail for us to swiftly reproduce the issue.
+
+## Submitting Pull Requests
+
+Contributions to Jupyter Examples are facilitated through GitHub Pull Requests. The FABRIC project adheres to a policy of requiring GPG-signed commits. Commits on the PR branch will be scrutinized to ensure they are signed. Signed commits are compulsory for a PR to be reviewed, approved, and merged.

Readme.md

@@ -1,7 +1,47 @@
-# Fabric Jupyter Hub Notebooks
-This repository contains Jupyter Notebooks for Fabric Testbed. These notebooks are available to the user when they logon to FABRIC Testbed Jupyter Hub.
+# Jupyter Examples for Fabric Testbed
+Welcome to the Fabric Testbed Jupyter Examples repository! This repository contains a collection of Jupyter Notebook 
+examples demonstrating various usage scenarios and features of the Fabric Testbed.
 
-## Basic Notebooks
-Following basic notebooks are available:
-- tokens : Python notebook depicting how to generate FABRIC Tokens which are a MUST for any experiment on FABRIC Testbed
-- orchestrator : Python notebook depicting basic Orchestrator APIS
+## About Fabric Testbed
+Fabric Testbed is a platform for building and managing virtualized network environments for research, 
+education, and experimentation. It provides users with access to programmable network resources, 
+allowing them to create, customize, and experiment with network topologies and configurations. 
+More details about the testbed can be found [here](https://portal.fabric-testbed.net/)
+
+## What's Included
+This repository includes a variety of Jupyter Notebook examples covering different aspects of the Fabric Testbed, 
+including:
+
+- Topology Creation: Examples demonstrating how to create custom network topologies using Fabric Testbed APIs.
+- Configuration Management: Examples showcasing how to configure network devices and services within the Fabric Testbed environment.
+- Experimentation and Analysis: Examples illustrating how to conduct experiments and analyze network performance and behavior using Fabric Testbed resources.
+
+More details available in the [Start Here Notebook](./start_here.ipynb)
+
+## Getting Started
+
+The easiest way to create experiments on FABRIC is using JupyterHub. 
+You can create your private JupyterHub environment by logging into the [FABRIC portal](https://portal.fabric-testbed.net/).
+
+Alternatively you can set up  your local environment by following these steps:
+
+- Clone the Repository: Clone this repository to your local machine using Git:
+```
+git clone https://github.com/fabric-testbed/jupyter-examples.git
+```
+- Install Dependencies: Install the necessary dependencies to run the Jupyter Notebooks as described [here](https://learn.fabric-testbed.net/knowledge-base/install-the-python-api/). Typically, this involves installing Python and Jupyter Notebook.
+
+- Explore the Examples: Open the Jupyter Notebooks (*.ipynb files) in your preferred Jupyter environment and explore the examples provided. Each notebook includes detailed instructions and explanations to guide you through the usage scenarios.
+
+- Experiment and Customize: Experiment with the provided examples, modify them to suit your needs, and explore the capabilities of the Fabric Testbed platform.
+
+## Contributing
+We welcome contributions from the community to enhance and expand the collection of Jupyter Notebook examples. 
+Please follow the guidelines for contributing as described [here](./CONTRIBUTING.md).
+
+## License
+This repository is licensed under the MIT License.
+
+## Contact
+If you have any questions, feedback, or issues related to the examples in this repository, 
+please feel free to open an issue or ask questions [here](https://learn.fabric-testbed.net/forums/forum/fabric-general-questions-and-discussion/).