From 33cca6f66f8fd3d36fe820322eb3ca92ee99a2c8 Mon Sep 17 00:00:00 2001 From: it33 Date: Sat, 20 Mar 2021 03:14:34 -0700 Subject: [PATCH] Updating website README --- website/README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/website/README.md b/website/README.md index e0eb9280f..571bd1004 100644 --- a/website/README.md +++ b/website/README.md @@ -1,8 +1,18 @@ # Focalboard website -Website for Focalboard, built using [Hugo](https://gohugo.io/). +This folder is used to manage the website at [focalboard.com](https://www.focalboard.com/). It was built using [Hugo](https://gohugo.io/). -## How to build +The content can be found in this folder: https://github.com/mattermost/focalboard/tree/main/website/site/content + +## How to contribute + +You're welcome to submit pull requests for typos, minor corrects and additions, troubleshooting tips to install guides and other incremental improvements. + +For larger changes, such as adding an install guide for a different platform, please create a [feature request](https://github.com/mattermost/focalboard/issues/new?assignees=&labels=enhancement&template=enhancement.md&title=Feature+Request%3A+) ticket to discuss. + +## How to build locally + +If you're interested in building the website locally from this repo using Hugo, please use the following steps: 1. Follow [Hugo documentation](https://gohugo.io/getting-started/installing/) to install Hugo