Focalboard Plugin Documentation

Welcome to the Focalboard plugin project! We’re very glad you want to check it out and perhaps contribute code to this project in GitHub.

Install the plugin

Visit the Mattermost Developer Documentation for details on how to install and enable the Focalboard plugin in your self-hosted Mattermost instance.

Enable the plugin

Once you’ve installed the Focalboard plugin, you can enable the plugin in the Mattermost System Console by going to Plugins > Plugin Management, and selecting the Enable option for the Focalboard plugin.

Learn what Focalboard plugin data is being collected

See the plugin data being collected documentation for details.

Use the plugin

See the Focalboard plugin end user guide for details on getting started with and using the plugin.

Manage plugin preferences

See the manage plugin preferences documentation for details.

Contribute to the Focalboard plugin project

Follow these simple steps to contribute:

1. Fork the Focalboard repo, clone it locally, and follow the steps in the README to build. Read the developer tips & tricks to get started.

2. Find help wanted tickets that are up for grabs in GitHub. Comment to let everyone know you’re working on it, and to allow a core contributor to assign the issue to you. If there’s no ticket for what you want to work on see contributions without a ticket.

3. When your changes are ready, run through our checklist for pull requests. Note that if it’s your first contribution, there is a standard CLA to sign.

Just ask if you need help!

You can find us on our public Focalboard channel on the Mattermost community server. Also feel free to file a bug for any issues you run into, or start a discussion.

We’re glad ❤️ you’re here! Good luck and have fun!