fediparty/README.md
2018-06-04 03:51:51 +03:00

66 lines
2.4 KiB
Markdown

# FEDIVERSE GUIDE
![website logo](./source/img/touch/favicon-32x32.png?raw=true) A quick look into Fediverse networks
### [Important](#notes)
- Logo icon on Pleroma page is [unofficial](https://gitlab.com/lostinlight/per_aspera_ad_astra/tree/master/pleroma-concept), with @lain's permission used until the official logo is chosen
- "World" text on postActiv page is by @Maiyannah Bishop, main postActiv developer
### [Goals](#goals)
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.
2. **Team Building**: Unite all federated social networks under 'Fediverse' name. Highlight the sense and spirit of a Fediverse community.
### [Contributing](#contributing)
Read [Contributing](./CONTRIBUTING.md)
### [Structure](#structure)
#### Fediverse page
*Data located in*: `/source/_data/fediversei18n.json` file
#### Chronicles page
*Data located in*: `/source/_posts` folder
#### Knowledge page
*Data located in*: `/source/_data/knowledge.json` file
#### Each network page
*Data located in*: `/source/_data/..network.json` and `/source/_data/world18n.json` files
#### Portal page
Supposed to link to a page helping to choose a server on any network (just an idea, for now)
### [Theme File Structure](#theme)
- Develop styles in `/themes/starter/assets/scss`
- Develop scripts in `/themes/starter/assets/scripts`
### [Setup](#setup)
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
### [Translating](#translating)
Maintaining several website translations will require extra work. Please, read [discussion](https://gitlab.com/fediverse/fediverse.gitlab.io/issues/9).
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`)
- `/source/_data` folder: fediversei18n.json, worldi18n.json
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.