From 858d571cd49c8936b5b8fc048172d67cd7b3a8e1 Mon Sep 17 00:00:00 2001 From: octopusinvitro Date: Thu, 20 Apr 2017 12:41:43 +0100 Subject: [PATCH] Add point under tribal knowledge section: everything is published. There is a small nuance between "published" documents and "unlinked" documents that may not be obvious to a newcomer to the codebase. So an explanation was filled under the tribal knowledge section of the contributing guide. --- .github/CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 0582a6cb..a85dabbb 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -112,6 +112,18 @@ keep adding things here, for the newcomers. different behavior, **we use the same classes for both posts and events**. +* All content pages from prose are published, but not all are + linked. This is a small nuance from the way we build the site. + Events and posts can be published or unpublished, and their + markdown files in prose have a `published` field in the + frontmatter. They are linked automatically if they have a + `published: true`. Summaries and info pages are always + published, so their markdown files in prose don't have a + `published` field in the frontmatter. They have to be linked + manually, for example, in the main menu. All content is + published because we add the unpublished posts/events and + unlinked info pages to the page used for scraping. + * Summaries are a particular case of `DocumentWithFrontmatter`. For example, they are always published so