devol/guida-fediverso
1
0
Fork 0
mirror of https://git.feneas.org/feneas/fediverse.git synced 2024-12-23 04:28:01 +01:00
Code Issues Projects Releases Wiki Activity

Update CONTRIBUTING

Browse Source
This commit is contained in:
lostinlight 2018-06-04 17:36:52 +03:00
parent 21adf22d8b
commit 08414b11c6
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
CONTRIBUTING.md
View File

@ -43,6 +43,8 @@ __Optional metadata__:
wanted: true wanted: true
featured: true featured: true
banner: "pic.jpg" banner: "pic.jpg"
authors: ["Jane Doe", "Mike Cole"]
avatar: "./img/mikecole.png"
``` ```
`Wanted` `Wanted`
@ -53,11 +55,18 @@ Add this metadata to a new internal website's article, to show the post in a pro
`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. `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). `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).
`Authors`
Required for "featured" posts only. Add the name you wish to be shown as the author.
`Avatar`
Optional for "featured" posts. If you want to add your avatar to the article, add a round .png image to `/source/img/authors` folder, then add its path to metadata. If you don't add an image, the default avatar will be shown. Avatar dimensions will be 85x85px.
### Writing an internal article ### 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). 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). 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).