Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Filled in missing links & applied small formatting updates #76

Merged
merged 1 commit into from
May 8, 2024
Merged

Filled in missing links & applied small formatting updates #76

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/about.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ The Mattermost Google Calendar integration enables a two-way integration between
- Automatically set your user status as Away or Do Not Disturb during scheduled events.

See the following documentation to install and use Mattermost Google Calendar integration:
- [Set up]() the Mattermost Google Calendar integration
- [Configure]() the Mattermost Google Calendar integration
- [Use]() the Mattermost Calendar integration
- [Set up](setup.md) the Mattermost Google Calendar integration
- [Configure](configuration.md) the Mattermost Google Calendar integration
- [Use](usage.md) the Mattermost Calendar integration
4 changes: 2 additions & 2 deletions docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Configure the Mattermost Google Calendar integration

In Mattermost, configure [Mattermost Google Calendar integration]() by going to **System Console > Plugin Management > Google Calendar**, entering the following values, and selecting **Save**.
In Mattermost, configure [Mattermost Google Calendar integration](about.md) by going to **System Console > Plugin Management > Google Calendar**, entering the following values, and selecting **Save**.

- **Enable Plugin**: Select `true` to enable the plugin for your Mattermost instance. Default `false`.
- **Admin User IDs**: Specify the user IDs who are authorized to manage the plugin in addition to Mattermost system admins. Separate multiple user IDs with commas. Go to **System Console > User Management > Users** to obtain a user’s ID.
Expand All @@ -20,4 +20,4 @@ If your Mattermost users encounter issues when connecting calendars, creating ev

3. Select **Enable** and wait for the **State** to change to **Running**.

See the [Mattermost Google Calendar integration usage]() documentation to learn how to use the Mattermost Google Calendar integration.
See the [Mattermost Google Calendar integration usage](usage.md) documentation to learn how to use the Mattermost Google Calendar integration.
14 changes: 7 additions & 7 deletions docs/setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Set up the Mattermost Google Calendar integration

Setting up the [Mattermost Google Calendar integration]() requires the following 3 steps:
Setting up the [Mattermost Google Calendar integration](about.md) requires the following 3 steps:

1. Mattermost admin: Install the Google Calendar plugin on your Mattermost instance.
2. Google admin: Create a Google Calendar service by creating a Google Cloud project.
Expand Down Expand Up @@ -28,9 +28,9 @@ To install the Mattermost Google Calendar plugin on your Mattermost server:

3. When your project is created, go to **APIs & Services** to search for and enable the following 2 services:

- **Google Calendar API**: Used for anything related to the calendar and events.
- **Google Calendar API**: Used for anything related to the calendar and events.

- **Google People API**: Used to link your Mattermost account to your Google account.
- **Google People API**: Used to link your Mattermost account to your Google account.

![In Google Cloud Console, select APIs & Services to search for services to enable.](google-cloud-console-apis.png)

Expand All @@ -55,18 +55,18 @@ To install the Mattermost Google Calendar plugin on your Mattermost server:

6. Under **Credentials**, create new OAuth 2.0 credentials by selecting **Create Credentials > OAuth client ID**.

- Under **Application type**, select **Web Application**.
- Under **Authorized redirect URIs** add `https://(MM_SITE_URL)/plugins/com.mattermost.gcal/oauth2/complete` and replace `MM_SITE_URL` with your Mattermost Server **Site URL**.
- Under **Application type**, select **Web Application**.
- Under **Authorized redirect URIs** add `https://(MM_SITE_URL)/plugins/com.mattermost.gcal/oauth2/complete` and replace `MM_SITE_URL` with your Mattermost Server **Site URL**.

![Under Credentials, select Web application.](google-cloud-console-web-application.png)

![Configure the authorized redirect URI for Mattermost.](google-cloud-console-authorized-redirect-uris.png)

7. Once the OAuth client is created, make a copy of the **Client ID** and **Client Secret** values for the configuration step.

![Copy the Client ID and Client secret values. You'll need these values in the configuration step.](google-cloud-console-OAuth-client-created.png)
![Copy the Client ID and Client secret values. You'll need these values in the configuration step.](google-cloud-console-OAuth-client-created.png)

See the [Mattermost Google Calendar integration configuration]() documentation to configure the Mattermost Google Calendar integration.
See the [Mattermost Google Calendar integration configuration](configuration.md) documentation to configure the Mattermost Google Calendar integration.

## Get help

Expand Down
Loading