Docs for Google Calendar integration #6585
Conversation
|
Newest code from cwarnermm has been published to preview environment for Git SHA c1b66b5 |
|
Newest code from cwarnermm has been published to preview environment for Git SHA 4035ea1 |
cwarnermm
added
1: Dev Review
|
Newest code from cwarnermm has been published to preview environment for Git SHA 8781392 |
There was a problem hiding this comment.
Thanks @cwarnermm! This documentation is excellent.
High-level questions:
- Where do we foresee location of docs for plugins to live long-term? We currently have some in our docs, some in the respective GitHub repositories, or a mix of both. Curious if we have a long-term plan, or if this is to be determined.
- Presentation of end user features: I've seen two different formats - a) bulleted sections, b) table with title, screenshot & description. Wondering about tradeoffs in the two approaches?
|
Newest code from cwarnermm has been published to preview environment for Git SHA 1d4e8c3 |
|
Great questions, @jasonblais!
In the short-term, the Google Calendar plugin docs sit parallel to the MS Teams Connector integration docs. CC @wiersgallak
Pros/cons The table format is the bigger lift in terms of effort (particularly due to the animated clip development), whereas the bulleted list approach is our current standard approach across the docs site. I'd like to see us move towards providing more robust education in the table format longer term, assuming resources are available for this effort (either in-house or via our development partners). The table/clip approach could become our gold standard MME-ready polished deliverable when a feature or workflow is feature complete and stable. However, in cases where the product functionality and maturation remains iterative/work in progress across a series of releases, (as is the case with this particular Mattermost integration) I recommend the bulleted approach due to its simplicity and low effort. |
There was a problem hiding this comment.
Superb work @cwarnermm ! This looks ages better that the basic documentation I worked on and it's easier to follow.
I did a quick review reading and following along and everything seems in place, I just put some comments on things that could be different and on a setting that we are removing.
If you need that I review things again (changes or otherwise) feel free to re-request my review :)
|
|
||
| The Mattermost Google Calendar integration enables a two-way integration between Mattermost and Google Calendar. With this integration, you can: | ||
|
|
||
| - Create and schedule events, invite guests, and post reminders in public channels. |
There was a problem hiding this comment.
I don't think we have any restriction on private channels. cc: @mickmister
There was a problem hiding this comment.
I couldn't get a private channel to show up in the drop-down. Only public channels were visible/available.
There was a problem hiding this comment.
@fmartingr This is the last outstanding updated needed for this docs update. Are private channels expected to work the same as public ones?
There was a problem hiding this comment.
AFAIK the only limitation we set is that the event organizer (creator) can write to the channel, but we didn't add any filters for private channels. @mickmister maybe is related to the changes to the channel autocomplete using the Mattermost Client now?
There was a problem hiding this comment.
For this docs release, I'll remove the clarification that only public channels operate this way. We can iterate on this content any time as needed. Thanks!
Co-authored-by: Felipe Martin <[email protected]>
|
Newest code from cwarnermm has been published to preview environment for Git SHA 8b4b9f8 |
|
Thanks @cwarnermm! |
|
Newest code from cwarnermm has been published to preview environment for Git SHA 3383409 |
|
Newest code from cwarnermm has been published to preview environment for Git SHA 5f4f613 |
|
Newest code from cwarnermm has been published to preview environment for Git SHA 6387889 |
cwarnermm
added
3: Reviews Complete
|
Newest code from cwarnermm has been published to preview environment for Git SHA c41bff8 |
|
Newest code from cwarnermm has been published to preview environment for Git SHA cc8543c |
Next steps:
Confirm whether the Google Calendar plugin fits under the Unified Operations use case section
Finalize plugin binary release install link in the admin docs
Finalize GitHub repository for the Google Calendar plugin to guide admins looking for help
Review content for technical accuracy and completeness:
@jasonblais @fmartingr @mickmister - I'd appreciate your help with reviews.
Also update this docs PR re: mattermost/mattermost-plugin-mscalendar#299