focalboard/website/README.md

# Focalboard website

This folder is used to manage the website at [focalboard.com](https://www.focalboard.com/). It was built using [Hugo](https://gohugo.io/).

- The main page for https://focalboard.com can be found at [/site/layouts/partials/hero.htm](site/layouts/partials).
- Other content can be found in the [/site/content](site/content) folder.

## How to contribute

The documentation for Focalboard (known as Boards in Mattermost) has moved to the [Mattermost Product Documentation](https://docs.mattermost.com/guides/boards.html) 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](https://github.com/mattermost/docs/blob/master/README.md) file or join the [Documentation Working Group channel](https://community.mattermost.com/core/channels/dwg-documentation-working-group) on our Community server.

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

```bash
# Eg. for Mac OS X
brew install hugo
```


2. Start the development server

```bash
make run
```

3. 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.
Product name 2021-01-26 19:49:49 +02:00			`# Focalboard website`
Hugo website 2021-01-08 00:12:26 +02:00
Updating website README 2021-03-20 12:14:34 +02:00			`This folder is used to manage the website at [focalboard.com](https://www.focalboard.com/). It was built using [Hugo](https://gohugo.io/).`
Hugo website 2021-01-08 00:12:26 +02:00
docker: fix docker file image and apply some good practices (#552) * docker: fix docker file image and apply some good practices * update docker-compose 2021-07-01 11:46:03 +02:00			`- The main page for https://focalboard.com can be found at [/site/layouts/partials/hero.htm](site/layouts/partials).`
			`- Other content can be found in the [/site/content](site/content) folder.`
Updating website README 2021-03-20 12:14:34 +02:00
docker: fix docker file image and apply some good practices (#552) * docker: fix docker file image and apply some good practices * update docker-compose 2021-07-01 11:46:03 +02:00			`## How to contribute`
Updating website README 2021-03-20 12:14:34 +02:00
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			`The documentation for Focalboard (known as Boards in Mattermost) has moved to the [Mattermost Product Documentation](https://docs.mattermost.com/guides/boards.html) 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](https://github.com/mattermost/docs/blob/master/README.md) file or join the [Documentation Working Group channel](https://community.mattermost.com/core/channels/dwg-documentation-working-group) on our Community server.`
Updating website README 2021-03-20 12:14:34 +02:00
docker: fix docker file image and apply some good practices (#552) * docker: fix docker file image and apply some good practices * update docker-compose 2021-07-01 11:46:03 +02:00			`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.`
Updating website README 2021-03-20 12:14:34 +02:00
docker: fix docker file image and apply some good practices (#552) * docker: fix docker file image and apply some good practices * update docker-compose 2021-07-01 11:46:03 +02:00			`## How to build locally`
Updating website README 2021-03-20 12:14:34 +02:00
docker: fix docker file image and apply some good practices (#552) * docker: fix docker file image and apply some good practices * update docker-compose 2021-07-01 11:46:03 +02:00			`If you're interested in building the website locally from this repo using Hugo, please use the following steps:`
Hugo website 2021-01-08 00:12:26 +02:00
			`1. Follow [Hugo documentation](https://gohugo.io/getting-started/installing/) to install Hugo`

			```bash
			`# Eg. for Mac OS X`
			`brew install hugo`
			```


			`2. Start the development server`

			```bash
			`make run`
			```

			`3. Go to http://localhost:1313 to see the running server`
Marketing/website redesign (#2881) * Focalboard website revamp work * Removed alternate grey footer * Update Contribute link and general styles * Updated homepage images * Update image src and alt for homepage * Update nav items and general styles * Fix menu items for focalboard.com internal pages * Update README with asset versioning notes. Update URLs in footer. Update asset versions in query strings. Co-authored-by: Jared <jared@presentlogic.com> Co-authored-by: Jared Thomas <jared.thomas@ela1.com> 2022-04-22 20:26:40 +02:00
			`## 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.