docs icon indicating copy to clipboard operation
docs copied to clipboard

Help Wanted: Re-create notification flow diagram source files using draw.io

Open cwarnermm opened this issue 1 year ago • 6 comments
trafficstars

Re-create the following 3 Mattermost notification flow charts using draw.io:

  1. Mattermost desktop notification flow chart for the notification FAQ docs section.
  2. Mattermost email notification flow chart for the notification FAQ docs section.
  3. Mattermost push notification flow chart for the notification FAQ docs section.

Guidelines

  • Ensure you save a copy of each flow chart as an XML file with a .drawio file extension, so that it's an editable source file that Mattermost can modify as needed.
  • Please try to replicate the appearance and scale of the current flow charts wherever possible in terms of colours, styles, fonts, etc.
  • You can choose to recreate a single flow chart only, rather than owning the re-creation of all 3 flow charts, if preferred. Clearly indicate your preference by commenting on this GitHub issue.
  • Comment on this GitHub issue if you encounter any questions, concerns, or blockers to request assistance.

Out of scope

It's not necessary to:

  • Save a copy of each flow chart as PNG
  • Create a docs PR to add updated flow chart images to the product documentation
  • Add Mattermost logos/branding to the flow charts

cwarnermm avatar Aug 16 '24 19:08 cwarnermm

Hi @cwarnermm, Does re-creation mean to just replicate the flow using draw.io as shown in PNG file?

SarthakKeshari avatar Aug 19 '24 16:08 SarthakKeshari

Hi @SarthakKeshari! Yes, that's correct. Our goal is to have source files for these flow diagrams that we can manage and maintain with changes where needed.

cwarnermm avatar Aug 19 '24 16:08 cwarnermm

Sure, May you assign this issue to me.

SarthakKeshari avatar Aug 19 '24 16:08 SarthakKeshari

Appreciate your help with this lift, @SarthakKeshari!

cwarnermm avatar Aug 19 '24 16:08 cwarnermm

May you let me know where in the docs repo I should place the .drawio files.

SarthakKeshari avatar Aug 19 '24 16:08 SarthakKeshari

@SarthakKeshari - Having the source files the Docs PR will be sufficient for now, thanks!

cwarnermm avatar Aug 19 '24 16:08 cwarnermm

@SarthakKeshari - Are you actively working on this issue?

cwarnermm avatar Sep 20 '24 13:09 cwarnermm

@cwarnermm, I have unassigned myself. Thankyou

SarthakKeshari avatar Sep 20 '24 15:09 SarthakKeshari

@cwarnermm - Is this still relevant? Has any work been done here?

TomerPacific avatar Oct 06 '24 16:10 TomerPacific

This ticket is available if you're interested, @TomerPacific! I'd appreciate your help with it!

cwarnermm avatar Oct 07 '24 14:10 cwarnermm

@cwarnermm - How does this look (as a start) for the first diagram?

diagram

TomerPacific avatar Oct 07 '24 19:10 TomerPacific

It's a great start, @TomerPacific, thank you!!

cwarnermm avatar Oct 07 '24 19:10 cwarnermm

@cwarnermm - Once I have the draw.io file (XML), would you like me to take a screenshot of it and put as an image? Or do you want to store it and reference it from the images directory?

TomerPacific avatar Oct 08 '24 19:10 TomerPacific

@TomerPacific - Please save a copy of each flow chart as an XML file with a .drawio file extension, so that it's an editable source file that Mattermost can modify as needed. Internally, we'll manage those source files further before publication.

cwarnermm avatar Oct 08 '24 19:10 cwarnermm

@cwarnermm - Where would you like this file to be saved in the project structure?

TomerPacific avatar Oct 09 '24 04:10 TomerPacific

@TomerPacific - Feel free to add the source files to /images. In this PR, note the filenames of the new images, please. Thank you!

cwarnermm avatar Oct 09 '24 12:10 cwarnermm

@cwarnermm - A PR has been opened -> https://github.com/mattermost/docs/pull/7470

TomerPacific avatar Oct 10 '24 21:10 TomerPacific