Skip to content

Commit

Permalink
Add point under tribal knowledge section: everything is published.
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
octopusinvitro committed Apr 27, 2017
1 parent a5ef1e1 commit 858d571
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 858d571

Please sign in to comment.