focalboard/website/README.md
Justine Geffen e0657dad9a
Update README.md (#1343)
* Update README.md

Updated the docs contribution information.

* Update README.md

* Update website/README.md
2021-11-22 17:16:25 +02:00

1.6 KiB

Focalboard website

This folder is used to manage the website at focalboard.com. It was built using Hugo.

How to contribute

The documentation for Focalboard (known as Boards in Mattermost) has moved to the Mattermost Product Documentation site.

We welcome pull requests for typos, minor corrections, content additions, troubleshooting tips, install guides, and any other incremental improvements. If you have any questions about the contribution process, take a look at the README file or join the Documentation Working Group channel on our Community server.

For larger changes, such as adding an install guide for a different platform, please create a feature request 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 to install Hugo
# Eg. for Mac OS X
brew install hugo
  1. Start the development server
make run
  1. Go to http://localhost:1313 to see the running server