Use the common docs from `google/open-source-pdks` repository. * Use a symlink to include `third_party/open-source-pdks/docs` under the local docs. * Add top level `CODE_OF_CONDUCT.md` file which points to the actual code of conduct location. * Add top level `CONTRIBUTING.md` file which points to the actual contributing guidelines. Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..737a9bb --- /dev/null +++ b/CODE_OF_CONDUCT.md
@@ -0,0 +1,8 @@ +This project follows the [Google Open Source Community Guidelines](https://opensource.google/conduct). + +A copy of these guidelines can be found locally in this repository at +[docs/open-source-pdks/code-of-conduct.rst](./docs/open-source-pdks/code-of-conduct.rst). + +A copy of these guidelines are also +[included in the published documentation](https://gf180mcu-pdk.readthedocs.io/en/latest//open-source-pdks/code-of-conduct.html) +located at <https://gf180mcu-pdk.rtfd.io>.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9823c13 --- /dev/null +++ b/CONTRIBUTING.md
@@ -0,0 +1,6 @@ +Guidelines for contributing can be found locally in this repository at +[docs/open-source-pdks/contributing.rst](./docs/open-source-pdks/contributing.rst). + +A copy of these guidelines are also +[included in the published documentation](https://gf180mcu-pdk.readthedocs.io/en/latest//open-source-pdks/contributing.html) +located at <https://gf180mcu-pdk.rtfd.io>.
diff --git a/docs/code-of-conduct.rst b/docs/code-of-conduct.rst deleted file mode 100644 index b0164f0..0000000 --- a/docs/code-of-conduct.rst +++ /dev/null
@@ -1,68 +0,0 @@ -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, -cultures, and opinions they bring to the projects and communities they -participate in. - -Every one of Google's open source projects and communities are inclusive -environments, based on treating all individuals respectfully, regardless -of gender identity and expression, sexual orientation, disabilities, -neurodiversity, physical appearance, body size, ethnicity, nationality, -race, age, religion, or similar personal characteristic. - -We value diverse opinions, but we value respectful behavior more. - -Respectful behavior includes: - -- Being considerate, kind, constructive, and helpful. -- Not engaging in demeaning, discriminatory, harassing, hateful, - sexualized, or physically threatening behavior, speech, and imagery. -- Not engaging in unwanted physical contact. - -Some Google open source projects -`may adopt <https://opensource.google/docs/releasing/preparing/#conduct>`__ -an explicit project code of conduct, which may have additional detailed -expectations for participants. Most of those projects will use our -`modified Contributor Covenant <https://opensource.google/docs/releasing/template/CODE_OF_CONDUCT/>`__. - -Resolve peacefully -~~~~~~~~~~~~~~~~~~ - -We do not believe that all conflict is necessarily bad; healthy debate -and disagreement often yields positive results. However, it is never -okay to be disrespectful. - -If you see someone behaving disrespectfully, you are encouraged to -address the behavior directly with those involved. Many issues can be -resolved quickly and easily, and this gives people more control over the -outcome of their dispute. If you are unable to resolve the matter for -any reason, or if the behavior is threatening or harassing, report it. -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 -Project Steward, who will receive and handle reports of code of conduct -violations. In the event that a project hasn't identified a Project -Steward, you can report problems by emailing opensource@google.com. - -We will investigate every complaint, but you may not receive a direct -response. We will use our discretion in determining when and how to -follow up on reported incidents, which may range from not taking action -to permanent expulsion from the project and project-sponsored spaces. We -will notify the accused of the report and provide them an opportunity to -discuss it before any action is taken. The identity of the reporter will -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 <https://indieweb.org/code-of-conduct>`_ -*and can also be found at* <https://opensource.google/conduct/>.
diff --git a/docs/contributing.rst b/docs/contributing.rst deleted file mode 100644 index 0d67502..0000000 --- a/docs/contributing.rst +++ /dev/null
@@ -1,36 +0,0 @@ -How to Contribute -================= - -We'd love to accept your patches and contributions to this project. -There are just a few small guidelines you need to follow. - -Contributor License Agreement ------------------------------ - -Contributions to this project must be accompanied by a Contributor -License Agreement. You (or your employer) retain the copyright to your -contribution; this simply gives us permission to use and redistribute -your contributions as part of the project. Head over to -https://cla.developers.google.com/ to see your current agreements on -file or to sign a new one. - -You generally only need to submit a CLA once, so if you've already -submitted one (even if it was for a different project), you probably -don't need to do it again. - -Code reviews ------------- - -All submissions, including submissions by project members, require -review. We use GitHub pull requests for this purpose. Consult `GitHub -Help <https://help.github.com/articles/about-pull-requests/>`__ for more -information on using pull requests. - -Community Guidelines --------------------- - -This project follows `Google's Open Source Community -Guidelines <https://opensource.google/conduct/>`__. - -.. include:: code-of-conduct - :start-after: community_guidelines_text
diff --git a/docs/index.rst b/docs/index.rst index ca054b2..5797b6e 100644 --- a/docs/index.rst +++ b/docs/index.rst
@@ -15,6 +15,8 @@ IPs/ips physical_verification/design_man + open-source-pdks/index + .. warning:: This documentation is currently a **work in progress**.
diff --git a/docs/open-source-pdks b/docs/open-source-pdks new file mode 120000 index 0000000..e96c7b8 --- /dev/null +++ b/docs/open-source-pdks
@@ -0,0 +1 @@ +../third_party/open-source-pdks/docs \ No newline at end of file