From 271859fc68aaf2429f7c5952cdc04862ac203ead Mon Sep 17 00:00:00 2001 From: Tim 'mithro' Ansell Date: Thu, 14 May 2020 18:24:39 -0700 Subject: [PATCH] docs: Move the code of conduct under the contributing section. Signed-off-by: Tim 'mithro' Ansell --- docs/code-of-conduct.rst | 21 +++++++++++---------- docs/conf.py | 1 + docs/contributing.rst | 3 +++ docs/index.rst | 5 ++--- 4 files changed, 17 insertions(+), 13 deletions(-) diff --git a/docs/code-of-conduct.rst b/docs/code-of-conduct.rst index ce5665d..3c58179 100644 --- a/docs/code-of-conduct.rst +++ b/docs/code-of-conduct.rst @@ -1,5 +1,7 @@ Google Open Source Community Guidelines -======================================= +--------------------------------------- + +.. community_guidelines_text At Google, we recognize and celebrate the creativity and collaboration of open source contributors and the diversity of skills, experiences, @@ -21,15 +23,14 @@ Respectful behavior includes: sexualized, or physically threatening behavior, speech, and imagery. - Not engaging in unwanted physical contact. -Some Google open source projects `may -adopt `__ +Some Google open source projects +`may adopt `__ an explicit project code of conduct, which may have additional detailed expectations for participants. Most of those projects will use our -`modified Contributor -Covenant `__. +`modified Contributor Covenant `__. Resolve peacefully ------------------- +~~~~~~~~~~~~~~~~~~ We do not believe that all conflict is necessarily bad; healthy debate and disagreement often yields positive results. However, it is never @@ -44,7 +45,7 @@ We are dedicated to providing an environment where participants feel welcome and safe. Reporting problems ------------------- +~~~~~~~~~~~~~~~~~~ Some Google open source projects may adopt a project-specific code of conduct. In those cases, a Google employee will be identified as the @@ -62,6 +63,6 @@ be omitted from the details of the report supplied to the accused. In potentially harmful situations, such as ongoing harassment or threats to anyone's safety, we may take action without notice. -*This document was adapted from the `IndieWeb Code of -Conduct `__ and can also be found -at https://opensource.google/conduct/.* +*This document was adapted from the* +`IndieWeb Code of Conduct `_ +*and can also be found at* . diff --git a/docs/conf.py b/docs/conf.py index 2b2804d..ac4865b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -118,6 +118,7 @@ exclude_patterns = [ 'env', 'Thumbs.db', '.DS_Store', + 'code-of-conduct.rst', ] # The name of the Pygments (syntax highlighting) style to use. diff --git a/docs/contributing.rst b/docs/contributing.rst index 4604acb..14f6b0f 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -31,3 +31,6 @@ Community Guidelines This project follows `Google's Open Source Community Guidelines `__. + +.. include:: code-of-conduct.rst + :start-after: community_guidelines_text diff --git a/docs/index.rst b/docs/index.rst index b0ea862..23d40fc 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,13 +3,12 @@ .. toctree:: :hidden: - contributing - code-of-conduct - Current Status known_issues versioning + contributing + Welcome to SkyWater SKY130 PDK's documentation! ===============================================