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

2
# FEDIVERSE GUIDE
lostinlight's avatar
lostinlight committed
3

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

6
### [Goals](#goals)
lostinlight's avatar
lostinlight committed
7

8
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
9

10
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
11

12
### [Contributing](#contributing)
lostinlight's avatar
lostinlight committed
13

14
Read [Contributing](./CONTRIBUTING.md)
lostinlight's avatar
lostinlight committed
15

16
### [Structure](#structure)
lostinlight's avatar
lostinlight committed
17 18 19

#### Fediverse page

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

#### Chronicles page

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

26
#### Knowledge page
lostinlight's avatar
lostinlight committed
27

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

30
#### Each network page
lostinlight's avatar
lostinlight committed
31

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

#### Portal page

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

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

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

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

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


50
### [Translating](#translating)
lostinlight's avatar
lostinlight committed
51

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

60
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.