Skip to content

Commit

Permalink
[docsy] Finalize Community and Contributing
Browse files Browse the repository at this point in the history
Signed-off-by: Patrice Chalin <[email protected]>
  • Loading branch information
chalin committed Nov 21, 2024
1 parent 0a72e60 commit 0f2834f
Show file tree
Hide file tree
Showing 8 changed files with 108 additions and 108 deletions.
6 changes: 1 addition & 5 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,2 @@
# Temporary: ignore top-level *.md until docsy branch is merged into main
CONTRIBUTING.md
README.md

/themes
/layouts
/layouts
53 changes: 1 addition & 52 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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 <http://localhost:1313>.

## 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.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
[![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
6 changes: 2 additions & 4 deletions content/en/community/_index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: Community
menu: { main: { weight: 40 } }
cascade:
type: docs
contributingUrl: /docs/contributing/
aliases: [/contact]
---

{{% community-lists %}}
70 changes: 70 additions & 0 deletions content/en/docs/contributing.md
Original file line number Diff line number Diff line change
@@ -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 <http://localhost:1313>.

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
2 changes: 1 addition & 1 deletion content/en/docs/faq.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Frequently asked questions
linkTitle: FAQ
weight: 10
weight: 1000
---

### Why the name “in-toto”?
Expand Down
40 changes: 23 additions & 17 deletions hugo.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
baseURL: https://in-toto.io
title: in-toto

# cSpell:ignore Catmull Libera noopener

disableKinds: [taxonomy]
theme: [docsy]
enableGitInfo: true
Expand Down Expand Up @@ -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
Expand All @@ -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:[email protected]
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:[email protected]
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:[email protected]
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:
Expand Down
27 changes: 0 additions & 27 deletions layouts/shortcodes/community-lists.html

This file was deleted.

0 comments on commit 0f2834f

Please sign in to comment.