agaric/documentation
10
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix formatting and put best version of duplicate section in correct section

Browse source
This commit is contained in:
benjamin melançon 2019-06-14 19:35:27 -04:00
parent 677e889269
commit 01c8717ce9
2 changed files with 7 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
documentation.rst
View file

@ -14,16 +14,17 @@ Edit or add. That's the primary instruction. You can edit directly on `gitlab.
Where to post what Where to post what
------------------ ------------------
We like `Gitlab's approach <https://about.gitlab.com/handbook/git-page-update/#where-should-content-go>`: If you're not sure where to put something in documentation, or if it even is documentation, `write a blog post <https://agaric.com/node/add/blog>`. Or even, in the Agaric context, just throw it in a `raw note <https://gitlab.com/agaric/resources/raw-notes>`. We like `Gitlab's approach <https://about.gitlab.com/handbook/git-page-update/#where-should-content-go>`_: If you're not sure where to put something in documentation, or if it even is documentation, `write a blog post <https://agaric.com/node/add/blog>`. Or even, in the Agaric context, just throw it in a `raw note <https://gitlab.com/agaric/resources/raw-notes>`_.
Somewhere is better than nowhere. Somewhere is better than nowhere.
Principles Guidelines
---------- ==========
* Document closest to where people work: * Document closest to where people work:
* In README.md files or otherwise in the code repository for developers, . * In README.md files or otherwise in the code repository for developers.
* Abstract and link here * 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:: .. note::
In documentation we are living our `values <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.

10
intra-team-communication.rst
View file

@ -24,13 +24,3 @@ Freenode has given us operator privileges for these channels. To use it, we nee
.. note:: .. note::
Agarics can get more detail `on communication channels in the wiki <https://gitlab.com/agaric/internal/wikis/Communication-Channels>`. Agarics can get more detail `on communication channels in the wiki <https://gitlab.com/agaric/internal/wikis/Communication-Channels>`.
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.