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.

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

Add documentation for Mattermost AI Copilot Plugin #7016

Closed
wants to merge 17 commits into from

Conversation

azigler
Copy link
Contributor

@azigler azigler commented Mar 29, 2024

Fixes #7004

Quick links:

@azigler azigler added Do Not Merge Should not be merged until this label is removed Work In Progress Not yet ready for review Area/Documentation Improvements Improvements to documentation preview-environment Allow the preview environment to be generated for Pull Requests coming from fork repositories labels Mar 29, 2024
@azigler azigler self-assigned this Mar 29, 2024
Copy link

Newest code from azigler has been published to preview environment for Git SHA eb42449

5 similar comments
Copy link

Newest code from azigler has been published to preview environment for Git SHA eb42449

Copy link

Newest code from azigler has been published to preview environment for Git SHA eb42449

Copy link

Newest code from azigler has been published to preview environment for Git SHA eb42449

Copy link

Newest code from azigler has been published to preview environment for Git SHA eb42449

Copy link

Newest code from azigler has been published to preview environment for Git SHA eb42449

… and content for better readability

The table formatting in the Mattermost AI Copilot User Guide was updated to improve readability and consistency. The changes include the removal of unnecessary columns and the adjustment of column widths to better fit the content. The title "Streaming Conversation" was also corrected to "Streaming Conversations" for grammatical accuracy.
Copy link

Newest code from azigler has been published to preview environment for Git SHA 9644576

… image links

The table formatting was updated to improve readability and consistency. The image link for the "AI RHS" section was also updated to ensure the correct image is displayed. This enhances the user's understanding of the guide by providing accurate visual aids and a cleaner presentation of the information.
Copy link

Newest code from azigler has been published to preview environment for Git SHA b75adc0

…er guides

The admin and user guides for the Mattermost AI Copilot plugin have been updated and enhanced for better clarity and understanding. The changes include a more structured layout, improved instructions for configuration and usage, and additional information about the plugin's features. The guides now provide a more comprehensive and user-friendly resource for administrators and users to effectively use the Mattermost AI Copilot plugin.
Copy link

Newest code from azigler has been published to preview environment for Git SHA 8bf1b26

…rences

🖼️ docs(mattermost-ai-copilot): replace image placeholders with actual images

The guide titles have been updated to follow a consistent format, making it easier for readers to understand the content at a glance. Cross-references have been added to each guide, directing administrators to the user guide and vice versa, providing a more seamless navigation experience. Image placeholders in the user guide have been replaced with actual images, enhancing the visual appeal and understanding of the guide.
Copy link

github-actions bot commented Apr 2, 2024

Newest code from azigler has been published to preview environment for Git SHA f7d43cb

…ides

The internal links in the Mattermost AI Copilot admin and user guides have been updated to use relative paths for better navigation. The note in the user guide has been changed to a tip to provide a more appropriate context for the information about accessing AI capabilities.
Copy link

github-actions bot commented Apr 2, 2024

Newest code from azigler has been published to preview environment for Git SHA 892e5ec

The internal links in the Mattermost AI Copilot admin and user guides were corrected to point to the right location. This change was necessary because the previous links were broken, leading to a 404 error. Now, users and administrators can navigate between the guides seamlessly.
Copy link

github-actions bot commented Apr 2, 2024

Newest code from azigler has been published to preview environment for Git SHA d7c0718

The internal links in the Mattermost AI Copilot admin and user guides were updated to include the .html extension. This change ensures that the links correctly redirect to the intended pages when clicked, improving the user experience and navigation within the documentation.
Copy link

github-actions bot commented Apr 2, 2024

Newest code from azigler has been published to preview environment for Git SHA 9fe77c3

@azigler azigler added 1: PM Review Requires review by a product manager 2: Editor Review Requires review by an editor and removed Do Not Merge Should not be merged until this label is removed Work In Progress Not yet ready for review labels Apr 2, 2024
Copy link

github-actions bot commented Apr 5, 2024

Newest code from azigler has been published to preview environment for Git SHA de4923e

Configuration Steps
-------------------

Configure the plugin via **System Console ➡️ Mattermost AI Copilot Plugin**. The following AI services are supported:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To clarify my earlier comment, I think we still want to first mention that admins have to install the plugin if <v9.7 with a link to the releases page of the repo. If >= v9.7 then they can follow the steps written here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, reworked this intro to better incorporate all of this.

Copy link

github-actions bot commented Apr 8, 2024

Newest code from azigler has been published to preview environment for Git SHA cca77ee

…patibility information

The title of the guide has been updated to "Admin Guide: Mattermost AI Copilot" for brevity and clarity. The compatibility information has been updated to reflect that the AI Copilot is now pre-installed in Mattermost Server versions 9.7 and later. This change provides more accurate and up-to-date information to the administrators.
Copy link

github-actions bot commented Apr 8, 2024

Newest code from azigler has been published to preview environment for Git SHA fa664cb

@azigler azigler requested a review from esethna April 8, 2024 23:48
@azigler
Copy link
Contributor Author

azigler commented Apr 8, 2024

@esethna Great feedback, I took another pass!

@cwarnermm Could you assist with the Enterprise labels and getting this documentation placed somewhere in the TOC (a temporary home is fine). Can we target getting this published and live by Thursday's Fast Futures meeting?


.. highlight:: Leverage the "Mattermost Calls" plugin to turn meeting recordings into actionable summaries. This feature ensures key points are captured and shared easily.

**Summarize Mattermost Calls**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rethinking this: Should we move this first given this is the highest impact feature based on current feedback?

@esethna esethna removed the 1: PM Review Requires review by a product manager label Apr 11, 2024
@esethna
Copy link
Contributor

esethna commented Apr 11, 2024

Left a few more minor comments, non-blocking, I think this just needs @cwarnermm's help re TOC and Enterprise labels where noted

Copy link

Newest code from esethna has been published to preview environment for Git SHA fa664cb

@azigler
Copy link
Contributor Author

azigler commented Apr 12, 2024

Thanks @esethna!

@cwarnermm could you help us with the final touches and getting this live? Let me know an ETA so I can convey that back to the Fast Futures team. Thanks!

Copy link

Newest code from azigler has been published to preview environment for Git SHA e281e26

@cwarnermm
Copy link
Member

cwarnermm commented Apr 12, 2024

@azigler - Yes! The integration consolidation docs effort is in progress via #7030. My plan is to incorporate the AI content from this PR there. Current ETA is by the end of the month (April).

Co-authored-by: Eric Sethna <14333569+esethna@users.noreply.github.com>
Copy link

Newest code from cwarnermm has been published to preview environment for Git SHA 64642dd

Copy link

Newest code from azigler has been published to preview environment for Git SHA 34bc685

@cwarnermm
Copy link
Member

@azigler - I'm closing this docs PR because the content has been incorporated into #7030.

@cwarnermm cwarnermm closed this Apr 26, 2024
@amyblais amyblais removed the 2: Editor Review Requires review by an editor label Apr 29, 2024
@jasonblais
Copy link
Contributor

Thanks @cwarnermm! Do we have an ETA on when #7030 will be merged along with Mattermost AI Copilot changes?

@cwarnermm
Copy link
Member

@jasonblais - ETA for #7030 is mid-May, or sooner.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area/Documentation Improvements Improvements to documentation preview-environment Allow the preview environment to be generated for Pull Requests coming from fork repositories
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation for Mattermost AI Copilot Plugin
5 participants