edit readme
This commit is contained in:
parent
17ee0fe237
commit
3ecc99ff4b
109
README.md
109
README.md
@ -1,89 +1,42 @@
|
||||
# Welcome to Welcome to ThreeFold Website RepositoryWebsite Repository
|
||||
# **Mycelium Website**
|
||||
|
||||
|
||||
This repository hosts the code for **Mycelium's web presence**, including both the main and development branches.
|
||||
|
||||
## About
|
||||
## 🌍 **Branches**
|
||||
- **`main`** → Production website: [mycelium.threefold.io](https://mycelium.threefold.io)
|
||||
- **`dev`** → Development version: [www2.mycelium.threefold.io](https://www2.mycelium.threefold.io)
|
||||
|
||||
The official website of ThreeFold Foundation. <br>
|
||||
## 🚀 **Overview**
|
||||
Mycelium is a decentralized networking and storage solution designed to integrate seamlessly with AI workloads, content delivery, and messaging. This repository contains the source code for the Mycelium website, built using **CSS, HTML, Tailwind, Markdown, and Zola**.
|
||||
|
||||
Production: [www.threefold.io](https://www.threefold.io) (master branch)
|
||||
|
||||
Staging: www2.threefold.io (development branch)
|
||||
|
||||
Last Updated: September 2024
|
||||
|
||||
## Administrators
|
||||
|
||||
[ThreeFold's Web Admins](https://github.com/orgs/threefoldfoundation/teams/team_web_admin)
|
||||
|
||||
## Contribution Procedure
|
||||
|
||||
|
||||
|
||||
It is highly important to follow this procedure to contribute to the website content. <br>
|
||||
__WARNING__: DO NOT commit straight into the __master__ / __development__ branches.
|
||||
|
||||
1. Feel free to [create a new issue](https://github.com/threefoldfoundation/www_threefold_io/issues/new) to report an error on the website, or if you have any suggestions on website improvements.
|
||||
|
||||
2. Make your own branch from the __development__ branch. By creating a new branch from __development__ you will be provided with the latest copy of the live website content at the staging site, www2.threefold.io.
|
||||
|
||||
3. Add your edits into your own branch via code editor locally, and push your local changes online. WARNING: DO NOT add your edits straight into __master__ / __development__ branch.
|
||||
|
||||
5. Create a PR to merge your own branch into **development**, and assign one of [ThreeFold's Web Admins](https://github.com/orgs/threefoldfoundation/teams/team_web_admin) on your PR as reviewer, or assign @sasha-astiadi as reviewer.
|
||||
|
||||
7. When PR is approved, you can see your changes on staging env on www2.threefold.io (development branch)
|
||||
|
||||
8. Admin will then create a PR to merge **development** into into **master** (production branch)
|
||||
|
||||
10. When PR is approved, you can see your changes live on production www.threefold.io (master branch).
|
||||
|
||||
## Development
|
||||
|
||||
While contributing content to this site doesn't strictly require setting up a development environment, it will allow you to preview your changes and that's super handy.
|
||||
|
||||
To do that, the following prerequisites are needed:
|
||||
|
||||
* macOS or Linux
|
||||
* [Zola](https://www.getzola.org/documentation/getting-started/installation/)
|
||||
|
||||
Then clone the repository recursively to also pull in contents of `threefold_data`:
|
||||
|
||||
```bash
|
||||
#if you don't have hero installed yet, run the following commands
|
||||
curl https://raw.githubusercontent.com/freeflowuniverse/crystallib/development/scripts/install_hero.sh > /tmp/hero_install.sh
|
||||
bash /tmp/hero_install.sh
|
||||
|
||||
#install zola & tailwind
|
||||
hero installers -n zola
|
||||
|
||||
#get this repo be careful --pr will remove all local changes (pull reset), -b development means we are on the development branch
|
||||
hero git pull -u https://github.com/threefoldfoundation/www_threefold_io -b development -pr
|
||||
|
||||
#cd to the directory
|
||||
eval $(hero git cd -u https://github.com/threefoldfoundation/www_threefold_io)
|
||||
|
||||
bash build.sh
|
||||
## 🛠 **Installation & Running Locally**
|
||||
### **Prerequisites**
|
||||
- **Zola** (static site generator)
|
||||
- **Tailwind CSS**
|
||||
- **Git** (for version control)
|
||||
|
||||
### **Clone the Repository**
|
||||
```sh
|
||||
git clone https://git.ourworld.tf/ourworld_web/www_mycelium.git
|
||||
cd www_mycelium
|
||||
```
|
||||
|
||||
Finally, start a browsable local copy of the site that will respond to changes in the source files like this:
|
||||
|
||||
```
|
||||
zola serve
|
||||
### **Install Dependencies**
|
||||
Run the following command to install all required dependencies:
|
||||
```sh
|
||||
./build.sh
|
||||
```
|
||||
|
||||
Zola will display a local address such as `http://127.0.0.1:1111` which you can click or copy and paste into your browser to view the site on your own machine.
|
||||
### **Preview the Website Locally**
|
||||
Start a local development server with:
|
||||
```sh
|
||||
./develop.sh
|
||||
```
|
||||
This will generate and serve the website for preview.
|
||||
|
||||
That's it—have fun!
|
||||
## 📌 **Issues & Contributions**
|
||||
Report bugs or suggest improvements in the issue tracker:
|
||||
🔗 [Issue Tracker](https://git.ourworld.tf/tfgrid/circle_web_presence/issues)
|
||||
|
||||
|
||||
# Guidelines for Editing Blog, News, and Team Images
|
||||
|
||||
### General:
|
||||
Ensure all images are optimized to be less than 1MB for faster loading and better performance.
|
||||
|
||||
### Blog & News:
|
||||
Use a resolution of **1200 x 600** pixels or maintain the same aspect ratio to fit seamlessly with placeholders.
|
||||
|
||||
### Team:
|
||||
Keep images square with a resolution of **640 x 640** pixels for consistent appearance.
|
||||
## 📜 **License**
|
||||
This project is open-source and licensed under [insert applicable license].
|
||||
|
||||
Loading…
Reference in New Issue
Block a user