diff --git a/documentation.rst b/documentation.rst index e261dfe..6980dc5 100644 --- a/documentation.rst +++ b/documentation.rst @@ -14,16 +14,17 @@ Edit or add. That's the primary instruction. You can edit directly on `gitlab. Where to post what ------------------ -We like `Gitlab's approach `: If you're not sure where to put something in documentation, or if it even is documentation, `write a blog post `. Or even, in the Agaric context, just throw it in a `raw note `. +We like `Gitlab's approach `_: If you're not sure where to put something in documentation, or if it even is documentation, `write a blog post `. Or even, in the Agaric context, just throw it in a `raw note `_. Somewhere is better than nowhere. -Principles ----------- +Guidelines +========== * Document closest to where people work: - * In README.md files or otherwise in the code repository for developers, . -* Abstract and link here + * In README.md files or otherwise in the code repository for developers. + * In the site itself for site managers and content editors, or alternatively in an organization's already established locations. +* Topics which are of general application can be abstracted, put in this repository, and linked to at this documentation. .. note:: - In documentation we are living our `values ` of encouraging continuous learning, appreciating new ideas, giving back to the communities we are part of, and valuing long-term relationships. + In doing documentation we are living our :ref:`values` of encouraging continuous learning, appreciating new ideas, giving back to the communities we are part of, and valuing long-term relationships. diff --git a/intra-team-communication.rst b/intra-team-communication.rst index 0adac01..1b6fe22 100644 --- a/intra-team-communication.rst +++ b/intra-team-communication.rst @@ -24,13 +24,3 @@ Freenode has given us operator privileges for these channels. To use it, we nee .. note:: Agarics can get more detail `on communication channels in the wiki `. -Principles ----------- - -* Document closest to where people work: - * In README.md files or otherwise in the code repository for developers. - * In the site itself for site managers and content editors, or alternatively in an organization's already established locations. -* Topics which are of general application can be abstracted, put in this repository, and linked to at this documentation. - -.. note:: - In doing documentation we are living our :ref:`values` of encouraging continuous learning, appreciating new ideas, giving back to the communities we are part of, and valuing long-term relationships.