README.md 2.15 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

6 7
[https://fediverse.party](https://fediverse.party)

lostinlight's avatar
lostinlight committed
8
### [Goals](#goals)
lostinlight's avatar
lostinlight committed
9

lostinlight's avatar
lostinlight committed
10
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
11

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

lostinlight's avatar
lostinlight committed
14
### [Contributing](#contributing)
lostinlight's avatar
lostinlight committed
15

lostinlight's avatar
lostinlight committed
16
Read [Contributing](./CONTRIBUTING.md)
lostinlight's avatar
lostinlight committed
17

lostinlight's avatar
lostinlight committed
18
### [Structure](#structure)
lostinlight's avatar
lostinlight committed
19 20 21

#### Fediverse page

lostinlight's avatar
lostinlight committed
22
*Data located in*: `/source/_data/fediverse.json` file
lostinlight's avatar
lostinlight committed
23 24 25 26 27

#### Chronicles page

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

lostinlight's avatar
lostinlight committed
28
#### Knowledge page
lostinlight's avatar
lostinlight committed
29

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

lostinlight's avatar
lostinlight committed
32
#### Each network page
lostinlight's avatar
lostinlight committed
33

lostinlight's avatar
lostinlight committed
34
*Data located in*: `/source/_data/..network.json` and `/source/_data/world.json` files
lostinlight's avatar
lostinlight committed
35 36 37

#### Portal page

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

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

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

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

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
52
### [Translating](#translating)
lostinlight's avatar
lostinlight committed
53

lostinlight's avatar
lostinlight committed
54
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
55 56 57 58 59
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`)
lostinlight's avatar
lostinlight committed
60
- `/source/_data` folder: fediverse.json, world.json
lostinlight's avatar
lostinlight committed
61

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