From d744b96388abf6a33cc4e9307d6015916d3488f8 Mon Sep 17 00:00:00 2001 From: Aitor Murguzur Date: Thu, 14 Mar 2024 18:19:30 +0100 Subject: [PATCH] Modify the SETUP.md and the README.md --- README.md | 41 +++++++++++++++-------------------------- SETUP.md | 4 ++-- 2 files changed, 17 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 0c6c2c2..b7c769d 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,30 @@ -# Website +# Biotz Academy -This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. +## Tutorials -### Installation +In this complete tutorial, you will find how to create effective data ingestion flow within the Biotz IoT platform, following the different steps. Starting with account creation, and continuing through several more steps. -``` -$ yarn -``` +## How-to guides -### Local Development +This collection of guides has been crafted to assist you in navigating the features of IoT development and implementation. -``` -$ yarn start -``` +## Reference -This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. +Your go-to resource for in-depth information about the IoT platform's funcionalities and components. -### Build -``` -$ yarn build -``` +## Local Development -This command generates static content into the `build` directory and can be served using any static contents hosting service. +The local development is explained step by step in the SETUP.md file. -### Deployment +## Deployment -Using SSH: +The deployment is made by the github/workflows deploy.yml. + +## Academy page + +Here is the Biotz Academy page. -``` -$ USE_SSH=true yarn deploy -``` -Not using SSH: -``` -$ GIT_USER= yarn deploy -``` -If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. diff --git a/SETUP.md b/SETUP.md index 7a6414d..c9e5a15 100644 --- a/SETUP.md +++ b/SETUP.md @@ -14,14 +14,14 @@ Make sure you have the following instaled on your system. ### 1. Clone the repository ```bash -git clone https://github.com/your_username/your_project.git +git clone git@github.com:biotz/academy.git ``` ### 2. Navigate to the Project Directory ```bash -cd your_project +cd academy ``` ### 3. Build and Run the Containers