From 08414b11c690f78d74396e02493b42990471039b Mon Sep 17 00:00:00 2001 From: lostinlight Date: Mon, 4 Jun 2018 17:36:52 +0300 Subject: [PATCH] Update CONTRIBUTING --- CONTRIBUTING.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b723aa0..3671eb4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -43,6 +43,8 @@ __Optional metadata__: wanted: true featured: true banner: "pic.jpg" +authors: ["Jane Doe", "Mike Cole"] +avatar: "./img/mikecole.png" ``` `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. -`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 -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).