focalboard/website
Chen-I Lim ad9e83e8fd
Port contributors guide to GitHub pages (#2296)
* Port contributor's guide to GitHub

* Fix #2178. Port contributors guide to GitHub pages

* Fix wrong file change

* typo

* Fix link

* Replace PR with pull request

* Remove comment

* Doc at-mention, headings

* Add sudo apt-get install autoconf dh-autoreconf

* database typo

* Update docs/dev-tips.md

Co-authored-by: Doug Lauder <wiggin77@warpmail.net>

* Update docs/index.md

Co-authored-by: Doug Lauder <wiggin77@warpmail.net>

* Update index.md

* Update dev-tips.md

Co-authored-by: Doug Lauder <wiggin77@warpmail.net>
Co-authored-by: Justine Geffen <justinegeffen@users.noreply.github.com>
2022-02-08 13:46:14 -08:00
..
site Port contributors guide to GitHub pages (#2296) 2022-02-08 13:46:14 -08:00
.editorconfig
.gitignore
Makefile
README.md

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