|
|
||
|---|---|---|
| .. | ||
| site | ||
| .editorconfig | ||
| .gitignore | ||
| Makefile | ||
| README.md | ||
Focalboard website
This folder is used to manage the website at focalboard.com. It was built using Hugo.
- The main page for https://focalboard.com can be found at /site/layouts/partials/hero.htm.
- Other content can be found in the /site/content folder.
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:
- Follow Hugo documentation to install Hugo
# Eg. for Mac OS X
brew install hugo
- Start the development server
make run
- Go to http://localhost:1313 to see the running server
Production Notes
For Assets (stylesheets, scripts, images)
If there are changes, please make sure that you change files names or update the version in the asset URL’s query string to help override the browser cache.
The main stylesheet (styles.css) can change quite frequently, so to update the version across all pages, you can go into layouts/partials/head.html and adjust the version query param.