tfgrid/info_tfgrid
30
3
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Activity

Merge pull request 'Update docs_projectinca/README.md' (#119) from development_quick_fix into development

Browse Source 
Reviewed-on: #119
This commit is contained in:
mik-tf 2024-07-03 18:57:42 +00:00
commit 97854b5b8f
1 changed files with 102 additions and 102 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

204
docs_projectinca/README.md
View File

@ -1,103 +1,103 @@
<h1> Project INCA Docs </h1> <h1> Project INCA Docs </h1>
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
- [Introduction](#introduction) - [Introduction](#introduction)
- [Prerequisites](#prerequisites) - [Prerequisites](#prerequisites)
- [Install the prerequisites on Ubuntu](#install-the-prerequisites-on-ubuntu) - [Install the prerequisites on Ubuntu](#install-the-prerequisites-on-ubuntu)
- [Install the prerequisites on MAC or Linux with Brew](#install-the-prerequisites-on-mac-or-linux-with-brew) - [Install the prerequisites on MAC or Linux with Brew](#install-the-prerequisites-on-mac-or-linux-with-brew)
- [Check if the Prerequisites Are Installed](#check-if-the-prerequisites-are-installed) - [Check if the Prerequisites Are Installed](#check-if-the-prerequisites-are-installed)
- [Clone the Repository](#clone-the-repository) - [Clone the Repository](#clone-the-repository)
- [Preview the Website](#preview-the-website) - [Preview the Website](#preview-the-website)
- [License](#license) - [License](#license)
- [References](#references) - [References](#references)
- [Contribute](#contribute) - [Contribute](#contribute)
--- ---
## Introduction ## Introduction
This subrepository contains the code to deploy the Project INCA Docs website, a project by [ThreeFold](https://threefold.io). This subrepository contains the code to deploy the Project INCA Docs website, a project by [ThreeFold](https://threefold.io).
## Prerequisites ## Prerequisites
You need [npm](https://www.npmjs.com/) to run this website. You need [npm](https://www.npmjs.com/) to run this website.
To clone the repository, you need `git`. To clone the repository, you need `git`.
To use the Makefile for quick deployment, you need `make` To use the Makefile for quick deployment, you need `make`
### Install the prerequisites on Ubuntu ### Install the prerequisites on Ubuntu
``` ```
sudo apt update sudo apt update
sudo apt install nodejs sudo apt install nodejs
sudo apt install git sudo apt install git
sudo apt install make sudo apt install make
``` ```
### Install the prerequisites on MAC or Linux with Brew ### Install the prerequisites on MAC or Linux with Brew
- [Install Brew](https://brew.sh/) - [Install Brew](https://brew.sh/)
``` ```
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
``` ```
- Install the prerequisites - Install the prerequisites
``` ```
brew install node brew install node
brew install git brew install git
brew install make brew install make
``` ```
### Check if the Prerequisites Are Installed ### Check if the Prerequisites Are Installed
``` ```
npm --version npm --version
git version git version
make --version make --version
``` ```
## Clone the Repository ## Clone the Repository
``` ```
git clone https://git.ourworld.tf/tfgrid/info_tfgrid git clone https://git.ourworld.tf/tfgrid/info_tfgrid
cd info_tfgrid/docs_projectinca cd info_tfgrid/docs_projectinca
``` ```
For more information, read the original [AstroWind docs](./docs_starlight/starlight_README.md). For more information, read the original [AstroWind docs](./docs_starlight/starlight_README.md).
## Preview the Website ## Preview the Website
You can preview the website with those two lines. You can preview the website with those two lines.
``` ```
npm install npm install
npm run dev npm run dev
``` ```
The equivalent can be achieved using the Makefile: The equivalent can be achieved using the Makefile:
``` ```
make run make run
``` ```
## License ## License
**INCA Docs** is licensed under the Apache 2.0 license — see the [LICENSE](../LICENSE.md) file for details. **INCA Docs** is licensed under the Apache 2.0 license — see the [LICENSE](../LICENSE) file for details.
## References ## References
This Project INCA Docs website is based on the amazing [AstroWind Starlight repo](https://github.com/withastro/starlight). This Project INCA Docs website is based on the amazing [AstroWind Starlight repo](https://github.com/withastro/starlight).
We changed the license from MIT to Apache 2.0 to suit this specific project. We changed the license from MIT to Apache 2.0 to suit this specific project.
## Contribute ## Contribute
To contribute to this repository: To contribute to this repository:
- Make a new branch with `development_` as a prefix (e.g. `development_update`) - Make a new branch with `development_` as a prefix (e.g. `development_update`)
- Make changes locally on your code editor - Make changes locally on your code editor
- Push changes to the new branch - Push changes to the new branch
- Make a pull request to `development` branch - Make a pull request to `development` branch
The code owners will merge `development` branch to `main` branch. The code owners will merge `development` branch to `main` branch.