README.md 2.21 KB
Newer Older
lostinlight's avatar
lostinlight committed
1

lostinlight's avatar
lostinlight committed
2
# FEDIVERSE GUIDE
lostinlight's avatar
lostinlight committed
3

lostinlight's avatar
lostinlight committed
4
![website logo](./source/img/touch/favicon-32x32.png?raw=true) A quick look into Fediverse networks
lostinlight's avatar
lostinlight committed
5

lostinlight's avatar
lostinlight committed
6
### [Important](#notes)
lostinlight's avatar
lostinlight committed
7

lostinlight's avatar
lostinlight committed
8
- "World" text on postActiv page is by @Maiyannah Bishop, main postActiv developer
lostinlight's avatar
lostinlight committed
9

lostinlight's avatar
lostinlight committed
10
### [Goals](#goals)
lostinlight's avatar
lostinlight committed
11

lostinlight's avatar
lostinlight committed
12
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.
lostinlight's avatar
lostinlight committed
13

lostinlight's avatar
lostinlight committed
14
2. **Team Building**: Unite all federated social networks under 'Fediverse' name. Highlight the sense and spirit of a Fediverse community.
lostinlight's avatar
lostinlight committed
15

lostinlight's avatar
lostinlight committed
16
### [Contributing](#contributing)
lostinlight's avatar
lostinlight committed
17

lostinlight's avatar
lostinlight committed
18
Read [Contributing](./CONTRIBUTING.md)
lostinlight's avatar
lostinlight committed
19

lostinlight's avatar
lostinlight committed
20
### [Structure](#structure)
lostinlight's avatar
lostinlight committed
21 22 23

#### Fediverse page

lostinlight's avatar
lostinlight committed
24
*Data located in*: `/source/_data/fediversei18n.json` file
lostinlight's avatar
lostinlight committed
25 26 27 28 29

#### Chronicles page

*Data located in*: `/source/_posts` folder

lostinlight's avatar
lostinlight committed
30
#### Knowledge page
lostinlight's avatar
lostinlight committed
31

lostinlight's avatar
lostinlight committed
32
*Data located in*: `/source/_data/knowledge.json` file
lostinlight's avatar
lostinlight committed
33

lostinlight's avatar
lostinlight committed
34
#### Each network page
lostinlight's avatar
lostinlight committed
35

lostinlight's avatar
lostinlight committed
36
*Data located in*: `/source/_data/..network.json` and `/source/_data/world18n.json` files
lostinlight's avatar
lostinlight committed
37 38 39

#### Portal page

lostinlight's avatar
lostinlight committed
40
Supposed to link to a page helping to choose a server on any network (just an idea, for now)
lostinlight's avatar
lostinlight committed
41

lostinlight's avatar
lostinlight committed
42
### [Theme File Structure](#theme)
lostinlight's avatar
lostinlight committed
43 44 45 46

- Develop styles in  `/themes/starter/assets/scss`
- Develop scripts in `/themes/starter/assets/scripts`

lostinlight's avatar
lostinlight committed
47
### [Setup](#setup)
lostinlight's avatar
lostinlight committed
48 49 50 51 52 53

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


lostinlight's avatar
lostinlight committed
54
### [Translating](#translating)
lostinlight's avatar
lostinlight committed
55

lostinlight's avatar
lostinlight committed
56
Maintaining several website translations will require extra work. Please, read [discussion](https://gitlab.com/fediverse/fediverse.gitlab.io/issues/9).
lostinlight's avatar
lostinlight committed
57 58 59 60 61 62 63
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

lostinlight's avatar
lostinlight committed
64
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.