277ea9facc
* Transitioning Boards > Focalboards plugin docs * Update docs/focalboard-plugin-end-user-guide.md * Update docs/get-started-with-board-templates.md * Update docs/get-started-with-board-templates.md * Update docs/group-filter-sort-boards.md * Update docs/group-filter-sort-boards.md * Update docs/share-collaborate.md * Update docs/import-export-backup-data.md * Update docs/import-export-backup-data.md * Fix MD table fomatting * Added data collection content * Added Focalboard import notes
40 lines
2.4 KiB
Markdown
40 lines
2.4 KiB
Markdown
# 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](https://developers.mattermost.com/integrate/plugins/using-and-managing-plugins/#custom-plugins) 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](plugin-data-being-collected.md) for details.
|
||
|
||
## Use the plugin
|
||
|
||
See the [Focalboard plugin end user guide](focalboard-plugin-end-user-guide.md) for details on getting started with and using the plugin.
|
||
|
||
## Manage plugin preferences
|
||
|
||
See the [manage plugin preferences documentation](manage-plugin-preferences.md) for details.
|
||
|
||
## Contribute to the Focalboard plugin project
|
||
|
||
Follow these simple steps to contribute:
|
||
|
||
1. [Fork the Focalboard repo](https://github.com/mattermost/focalboard), clone it locally, and follow the steps in the README to build. Read the [developer tips & tricks](dev-tips.md) to get started.
|
||
|
||
2. Find [help wanted tickets that are up for grabs in GitHub](https://github.com/mattermost/focalboard/issues?q=is%3Aopen+is%3Aissue+label%3A%22Up+for+grabs%22). 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](contributions-without-ticket.md).
|
||
|
||
3. When your changes are ready, run through our [checklist for pull requests](contribution-checklist.md). Note that if it’s your first contribution, there is a standard [CLA](https://www.mattermost.org/mattermost-contributor-agreement/) to sign.
|
||
|
||
## Just ask if you need help!
|
||
|
||
You can find us on our [public Focalboard channel](https://community.mattermost.com/core/channels/focalboard) on the Mattermost community server. Also feel free to [file a bug](https://github.com/mattermost/focalboard/issues/new/choose) for any issues you run into, or [start a discussion](https://github.com/mattermost/focalboard/discussions).
|
||
|
||
We're glad ❤️ you're here! Good luck and have fun!
|