From 0f2834f59f59d5dafbdc438ff3430a1ff189d3d9 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Thu, 21 Nov 2024 12:33:10 -0500 Subject: [PATCH] [docsy] Finalize Community and Contributing Signed-off-by: Patrice Chalin --- .prettierignore | 6 +-- CONTRIBUTING.md | 53 +------------------ README.md | 12 ++++- content/en/community/_index.md | 6 +-- content/en/docs/contributing.md | 70 +++++++++++++++++++++++++ content/en/docs/faq.md | 2 +- hugo.yaml | 40 ++++++++------ layouts/shortcodes/community-lists.html | 27 ---------- 8 files changed, 108 insertions(+), 108 deletions(-) create mode 100644 content/en/docs/contributing.md delete mode 100644 layouts/shortcodes/community-lists.html diff --git a/.prettierignore b/.prettierignore index be9db56..427ad12 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1,6 +1,2 @@ -# Temporary: ignore top-level *.md until docsy branch is merged into main -CONTRIBUTING.md -README.md - /themes -/layouts \ No newline at end of file +/layouts diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2061311..dcad42e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,54 +1,3 @@ # Contributing to in-toto.io -Thank you for considering contributing to in-toto.io! Here are the steps to set up the project on your local machine. - -## Review Contribution Guidelines - -Before contributing, please review our detailed [contribution guidelines](https://github.com/in-toto/community/blob/main/CONTRIBUTING.md) to ensure that your code follows our style guidelines and is properly tested. - -## Sign the Developer Certificate of Origin (DCO) - -All contributors must sign the Developer Certificate of Origin (DCO) by adding a "Signed-off-by" line to their commit messages. This indicates your acceptance of the DCO. You can do this by appending the following line to each commit message (see [git commit --signoff](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---signoff)) - -## Quick Start Guide - -To get started with contributing to in-toto.io, follow these steps: - -### 1. Clone the Repository - -Clone the in-toto.io git repository to your local machine: - -```sh -git clone https://github.com/in-toto/in-toto.io.git -``` - -### 2. Install Development Dependencies - -Navigate to the project root directory and install the necessary dependencies with Yarn. If you do not have Yarn installed, please install it by following the instructions on the [Yarn installation guide](https://classic.yarnpkg.com/en/docs/install): - -```sh -cd in-toto.io -npm install -``` - -### 3. Install Hugo - -We use Hugo to build the site. Follow the [Hugo installation guide](https://gohugo.io/installation/) to install Hugo on your system. - -### 4. Serve the website - -Once Hugo is installed, you can locally serve the website to see your changes in -real-time: - -```sh -npm run serve -``` - -This starts a local server. View the site at the URL displayed in your -terminal, usually . - -## Need Help? - -If you encounter any issues or have any questions, feel free to open an issue on the repository or reach out to the maintainers. - -**Happy contributing!** +See our [Contributing](https://in-toto.io/docs/contributing/) webpage. diff --git a/README.md b/README.md index f28e7ab..7d17056 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,11 @@ -# The in-toto website +# in-toto.io -[![Netlify Status](https://api.netlify.com/api/v1/badges/59e9b859-0349-41dc-b194-0bd636f9a8ac/deploy-status)](https://app.netlify.com/sites/in-toto/deploys) \ No newline at end of file +[![Netlify Status](https://api.netlify.com/api/v1/badges/59e9b859-0349-41dc-b194-0bd636f9a8ac/deploy-status)](https://app.netlify.com/sites/in-toto/deploys) + +Website repository for [in-toto.io] built with [Hugo] using the [Docsy] theme +and hosted on [Netlify]. + +[Docsy]: https://docsy.dev +[Hugo]: https://gohugo.io +[Netlify]: https://netlify.com +[in-toto.io]: https://in-toto.io diff --git a/content/en/community/_index.md b/content/en/community/_index.md index 3feeca4..7669898 100644 --- a/content/en/community/_index.md +++ b/content/en/community/_index.md @@ -1,8 +1,6 @@ --- title: Community menu: { main: { weight: 40 } } -cascade: - type: docs +contributingUrl: /docs/contributing/ +aliases: [/contact] --- - -{{% community-lists %}} diff --git a/content/en/docs/contributing.md b/content/en/docs/contributing.md new file mode 100644 index 0000000..b23cfcb --- /dev/null +++ b/content/en/docs/contributing.md @@ -0,0 +1,70 @@ +--- +title: Contributing +weight: 700 +--- + +Thank you for considering contributing to in-toto.io! Here are the steps to set +up the project on your local machine. + +## Review Community Contribution Guidelines + +Start by reviewing our +[community contribution guidelines](https://github.com/in-toto/community/blob/main/CONTRIBUTING.md) +to ensure that your code follows our style guidelines and is properly tested. + +## Sign the Developer Certificate of Origin (DCO) + +All contributors must sign the Developer Certificate of Origin (DCO) by adding a +"Signed-off-by" line to their commit messages. This indicates your acceptance of +the DCO. For details, see [git commit --signoff]. + +[git commit --signoff]: + https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---signoff + +## Setting up for local development + +To get started with contributing to in-toto.io, follow these steps: + +### 1. Clone the Repository + +Clone the in-toto.io git repository to your local machine: + +```sh +git clone https://github.com/in-toto/in-toto.io.git +``` + +### 2. Install Development Dependencies + +Change to the project root directory and install project dependencies, including +[Hugo]: + +```sh +cd in-toto.io +npm install +``` + +### 3. Serve the website + +Locally serve the website to see your changes in real-time: + +```sh +npm run serve +``` + +This starts a local server. View the site at the URL displayed in your terminal, +usually . + +To only build the site, run: + +```sh +npm run build +``` + +## Need Help? + +If you encounter any issues or have any questions, feel free to open an issue on +the repository or reach out to the maintainers. + +**Happy contributing!** + +[Hugo]: https://gohugo.io diff --git a/content/en/docs/faq.md b/content/en/docs/faq.md index 07b8e57..b9bf13c 100644 --- a/content/en/docs/faq.md +++ b/content/en/docs/faq.md @@ -1,7 +1,7 @@ --- title: Frequently asked questions linkTitle: FAQ -weight: 10 +weight: 1000 --- ### Why the name “in-toto”? diff --git a/hugo.yaml b/hugo.yaml index 9206a8e..a5b0a6e 100644 --- a/hugo.yaml +++ b/hugo.yaml @@ -1,6 +1,8 @@ baseURL: https://in-toto.io title: in-toto +# cSpell:ignore Catmull Libera noopener + disableKinds: [taxonomy] theme: [docsy] enableGitInfo: true @@ -45,8 +47,7 @@ params: in-toto Authors | Docs [CC BY 4.0](https://creativecommons.org/licenses/by/4.0) from_year: 2020 - github_repo: https://github.com/in-toto/in-toto.io - # gcs_engine_id: 011217106833237091527:la2vtv2emlw # FIXME: get ID for this site + github_repo: &repo https://github.com/in-toto/in-toto.io ui: showLightDarkModeMenu: true @@ -65,26 +66,31 @@ params: links: user: - - name: GitHub Discussions - url: https://github.com/in-toto/community - icon: fa-brands fa-github - desc: Discussion and help from your fellow users - - name: User mailing list - url: mailto:in-toto-public@googlegroups.com - icon: fa-solid fa-envelope - desc: Sign up for announcements + - name: Mailing list + url: https://groups.google.com/g/in-toto-public + icon: fa-solid fa-user-group + desc: Join our public mailing list (Google group). - name: Slack - url: https://slack.cncf.io/ + url: https://slack.cncf.io icon: fa-brands fa-slack - desc: in-toto on CNCF Slack Workspace + desc: Connect with us on the CNCF \#in-toto channel. + - name: Email + url: mailto:in-toto-dev@googlegroups.com + icon: fa-solid fa-envelope + desc: Write to developers. - name: IRC url: https://web.libera.chat/#in-toto icon: fa-solid fa-comments - desc: in-toto on libera - - name: Email developers - url: mailto:in-toto-dev@googlegroups.com - icon: fa-solid fa-envelope - desc: Email developers + desc: Chat with us on Libera. + developer: + - name: Community repository + url: https://github.com/in-toto/community + icon: fa-solid fa-users + desc: Community charter, governance, and more. + - name: Documentation + url: *repo + icon: fa-brands fa-github + desc: Website repository for in-toto. module: mounts: diff --git a/layouts/shortcodes/community-lists.html b/layouts/shortcodes/community-lists.html deleted file mode 100644 index bd0116c..0000000 --- a/layouts/shortcodes/community-lists.html +++ /dev/null @@ -1,27 +0,0 @@ -{{ $links := .Site.Params.links -}} - -

{{ T "community_introduce" . }}

- -## {{ T "community_learn" }} - -{{ T "community_using" . }} - -{{ with index $links "user"}} - {{ template "community-links-list" . }} -{{ end }} - -## {{ T "community_develop" }} - -{{ T "community_contribute" . }} - -{{ with index $links "developer"}} - {{ template "community-links-list" . }} -{{ end }} - -{{ T "community_how_to" . }} {{ T "community_guideline" }}. - -{{ define "community-links-list" -}} -{{ range . }} -- [ {{ .name }}]({{ .url }}): {{ .desc -}} -{{ end -}} -{{ end -}}