Commit 9979fd86 authored by lostinlight's avatar lostinlight

Update README, add CONTRIBUTING

parent 264ba343
# CONTRIBUTING
Don't hesitate to send a merge request!
Two easy and most welcome ways to contribute are:
1. submitting short news to The Chronicles
2. writing an internal article for the website
### Submitting news
**Data located in**: `/source/_posts` folder
**[Chronicles](https://fediverse.party/en/chronicles)** page aggregates latest news about major releases, development, interviews, related projects of Fediverse *social networks* (i.e., all the networks listed on main page).
Posts are available via [RSS](https://fediverse.gitlab.io/atom.xml) subscription.
`Preview` is rendered on Chronicles page (limited ammount), text after metadata is shown in RSS (unlimited).
Every post **must have** the following __metadata__:
```
layout: "post"
title: "some title"
date: 2222-01-25
tags:
- pleroma
preview:
"short gist..."
url: "https://pleroma.social/link-to-news-source"
lang: en
```
`Tags`
A post may have one of these tags: fediverse, gnusocial, diaspora, friendica, hubzilla, mastodon, postactiv, pleroma, socialhome, ganggo, misskey, peertube, aardwolf
`Preview`
Limit 150 characters - for "regular" and "wanted" posts, limit 350 characters - for "featured" post.
Please, make preview a 150-characters note (350-characters for "featured"), otherwise it gets truncated half-sentence and will be posted that way on the Chronicles front page. Not good.
__Optional metadata__:
```
wanted: true
featured: true
banner: "pic.jpg"
```
`Wanted`
Add this metadata to a post that you wish to show in the upper visible part of the Chronicles page. Calls for contribution, donations, help should be posted with this metadata.
`Featured`
Add this metadata to a new internal website's article, to show the post in a prominent part of the Chronicles page.
`Wanted` and `featured` can't be mixed and are temporary. This metadata should be removed from an older post when creating a new "featured" or "wanted" post.
`banner`: required for "featured" posts only, an image wide enough to be used as a fullscreen background, should be placed in `/source/_posts/exact-post-file-name` folder. See [example](./source/_posts/Why-use-federated-networks).
### Writing an internal article
Please, feel free to work on [FAQ](https://fediverse.party/en/post/FAQ-for-newcomers), [Why use federated networks](https://fediverse.party/en/post/Why-use-federated-networks) stub articles, or submit a piece dedicated to the topic of your own choosing (related to Fediverse social networks).
Each new internal article will be posted as "featured" in the prominent part of the Chronicles page, and will stay there for a while. It will also be distributed via RSS subscription. Your name and avatar will be featured as the author(s).
Please, consider submitting an original text that hasn't yet been published elsewhere. If you have a good relevant post on your own blog, submit it as a link addition to any Network page or Fediverse page. It doesn't make much sense to duplicate content.
A merge request with an article will include all the things mentioned above for a `featured` post: a file placed in `/source/_posts` folder with necessary metadata, a 350-character preview and full text after metadata section, written in markdown. A banner image should be added to `/source/_posts/exact-post-file-name` folder that you'll create. Any other images used in the article may be placed there as well.
**Thanks in advance!**
## Fediverse WIKI
# FEDIVERSE GUIDE
A quick look into Fediverse networks
![website logo](./source/img/touch/favicon-32x32.png?raw=true) A quick look into Fediverse networks
~~~
Work in progress
~~~
### Important
### [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
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.
### [Goals](#goals)
2. *Team Building*: Unite all federated social networks under 'Fediverse' name. Highlight the sense and spirit of a Fediverse community.
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.
### Contributing
2. **Team Building**: Unite all federated social networks under 'Fediverse' name. Highlight the sense and spirit of a Fediverse community.
> All the files you need are in `/source/_data` and `/source/_posts` folders
### [Contributing](#contributing)
Help welcome with the following pages:
- 'Knowledge' page: two stub articles "FAQ for newcomers" and "Why use federated networks" waiting to be written.
Read [Contributing](./CONTRIBUTING.md)
### Structure
### [Structure](#structure)
#### Fediverse page
*Data located in*: `/source/_data/fediversei18n.json` file.
*Data located in*: `/source/_data/fediversei18n.json` file
#### Chronicles page
> Latest news about major releases, development, interviews, articles, related stuff.
*Data located in*: `/source/_posts` folder
All posts are available via RSS subscription.
'Preview' is rendered on Chronicles page (limited ammount), text after metadata is shown in RSS (unlimited).
Every post must have the following __metadata__:
```
layout: "post"
title: "some title"
date: 2222-01-25
tags:
- pleroma
preview:
"short gist..."
url: "https://test.com"
lang: en
```
`Tags`: networkName / fediverse; most posts will have 1 tag
`Preview`: limit 150 characters - for "regular" and "wanted" posts, limit 350 characters - for "featured" post.
__Optional metadata__:
```
wanted: true
featured: true
banner: "pic.jpg"
```
#### Knowledge page
`Wanted` and `featured` can't be mixed and are temporary, should be removed from older post when creating a new "featured" or "wanted" post.
`banner`: required for "featured" posts only.
*Data located in*: `/source/_data/knowledge.json` file
#### Knowledge page
#### Each network page
*Data located in*: `/source/_data/knowledge.json` file.
*Data located in*: `/source/_data/..network.json` and `/source/_data/world18n.json` files
#### Portal page
Supposed to link to a page helping to choose any pod on any network (just-an-idea for now)
Supposed to link to a page helping to choose a server on any network (just an idea, for now)
### Theme File Structure
### [Theme File Structure](#theme)
- Develop styles in `/themes/starter/assets/scss`
- Develop scripts in `/themes/starter/assets/scripts`
### Setup
### [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](#translating)
Only English version.
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:
......@@ -98,4 +62,4 @@ Mandatory for translating:
- common strings (`/themes/starter/languages/en`)
- `/source/_data` folder: fediversei18n.json, worldi18n.json
Translating Chronicles or Knowledge pages content doesn't make sense. They will be mostly a collection of external articles.
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.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment