2018-03-22 02:48:05 +00:00
2018-06-04 00:51:51 +00:00
# FEDIVERSE GUIDE
2018-03-22 02:48:05 +00:00
2018-06-04 00:51:51 +00:00
 A quick look into Fediverse networks
2018-03-22 02:48:05 +00:00
2020-03-07 20:14:32 +00:00
→ [https://fediverse.party ](https://fediverse.party ) ←
2018-06-04 00:51:51 +00:00
### [Goals](#goals)
2018-03-22 02:48:05 +00:00
2018-06-04 00:51:51 +00:00
1. **Road Making** : Provide links to information scattered around the internet. Make it easier for newcomers to get acquainted with the idea in general and with every federated network in particular.
2018-03-22 02:48:05 +00:00
2018-06-04 00:51:51 +00:00
2. **Team Building** : Unite all federated social networks under 'Fediverse' name. Highlight the sense and spirit of a Fediverse community.
2018-03-22 02:48:05 +00:00
2018-06-04 00:51:51 +00:00
### [Contributing](#contributing)
2018-03-22 02:48:05 +00:00
2018-06-04 00:51:51 +00:00
Read [Contributing ](./CONTRIBUTING.md )
2018-03-22 02:48:05 +00:00
2020-08-03 22:30:53 +00:00
→ Check out [our Wiki ](https://git.feneas.org/feneas/fediverse/-/wikis/home ) ←
2018-06-04 00:51:51 +00:00
### [Structure](#structure)
2018-03-22 02:48:05 +00:00
#### Fediverse page
2018-12-31 18:45:18 +00:00
*Data located in*: `/source/_data/fediverse.json` file
2018-03-22 02:48:05 +00:00
#### Chronicles page
*Data located in*: `/source/_posts` folder
2018-06-04 00:51:51 +00:00
#### Knowledge page
2018-03-22 02:48:05 +00:00
2018-06-04 00:51:51 +00:00
*Data located in*: `/source/_data/knowledge.json` file
2018-03-22 02:48:05 +00:00
2018-06-04 00:51:51 +00:00
#### Each network page
2018-03-22 02:48:05 +00:00
2018-12-31 18:45:18 +00:00
*Data located in*: `/source/_data/..network.json` and `/source/_data/world.json` files
2018-03-22 02:48:05 +00:00
#### Portal page
2018-06-04 00:51:51 +00:00
Supposed to link to a page helping to choose a server on any network (just an idea, for now)
2018-03-22 02:48:05 +00:00
2018-06-04 00:51:51 +00:00
### [Theme File Structure](#theme)
2018-03-22 02:48:05 +00:00
- Develop styles in `/themes/starter/assets/scss`
- Develop scripts in `/themes/starter/assets/scripts`
2018-06-04 00:51:51 +00:00
### [Setup](#setup)
2018-03-22 02:48:05 +00:00
2020-08-03 22:30:53 +00:00
This site uses [Hexo ](https://hexo.io ) static generator. Follow these steps to spin up a local development environment:
2018-03-22 02:48:05 +00:00
1. Run `npm install` in main project's folder
2. Run `gulp` in `/themes/starter` folder
3. In second terminal, run `hexo server` in main folder, to start the server and preview at localhost
2018-06-04 00:51:51 +00:00
### [Translating](#translating)
2018-03-22 02:48:05 +00:00
2020-08-03 22:30:53 +00:00
Maintaining several website translations will require extra work. Please, read [discussion ](https://git.feneas.org/feneas/fediverse/-/issues/2 ).
2018-03-22 02:48:05 +00:00
Adding another language requires additions to `_config` file and `/themes/starter/languages` folder.
Mandatory for translating:
- create lang folder (`/source/*lang*`)
- common strings (`/themes/starter/languages/en`)
2018-12-31 18:45:18 +00:00
- `/source/_data` folder: fediverse.json, world.json
2018-03-22 02:48:05 +00:00
2018-06-04 00:51:51 +00:00
Translating Chronicles and Knowledge page content doesn't make sense (?). They will be mostly a collection of external English articles. If you're willing to become a permanent news contributor in another language and to search for Fediverse news in that language, let's discuss it in the issue.
