Fixed image, title and content

[milexm]

No description provided.

[ghost]

Thank you for your submission, we really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.

❌ milexm sign now
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[chrispsommers]

It's good to see the original source image file (Visio) file being added to the repo. I assume the file is edited in Visio and exported as a .png for inclusion in the .md files.

I would suggest that going forward, for new images, we strive to use the .svg file format, which has a few advantages: (1) Anyone can edit w/o a license, e.g. using draw.io desktop or similar. (2) It can be included in the .md file directly as .svg, saving a step (3) it can be viewed in the .md file while editing (e.g. using VScode preview) (4) no separate .png file is needed, saving disk space. I've been taking this approach in the test HLD. Thanks.

[milexm]

Hello Chris, I did change the image type to SVG. Can you see the related PR? I am supposed to join the team as a tech writer in a couple of weeks. Right now I do not have access to the repo just experimenting, using the forked version. Thanks, Michael

…

On Thu, Nov 18, 2021 at 9:14 AM Chris Sommers ***@***.***> wrote: ***@***.**** commented on this pull request. It's good to see the original source image file (Visio) file being added to the repo. I assume the file is edited in Visio and exported as a .png for inclusion in the .md files. I would suggest that going forward, for new images, we strive to use the .svg file format, which has a few advantages: (1) Anyone can edit w/o a license, e.g. using draw.io desktop or similar. (2) It can be included in the .md file directly as .svg, saving a step (it can be viewed in the .md file while editing (e.g. using VScode preview) (4) no separate .png file is needed, saving disk space. I've been taking this approach in the test HLD. Thanks. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#8 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ADQ3F7V5A2GBWVOSPD3QREDUMUX7VANCNFSM5IKC4TBA> . Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>.

[chrispsommers]

Hi Michael,
I do appreciate you exploring my suggestions. I saw the changes you made. I can view the changed file in your fork and it looks fine. However, I cloned your fork and tried to open the .svg file from within Draw.io desktop and it gives me an error saying “Not a media file.” I am not an expert in .svg format, but I wonder if it is not an editable SVG file?

The true value of using .svg as the single source for diagrams is it’s entirely self-contained, can be viewed and edited using many free tools. If you still need Visio to produce the original content and export to .svg, you get some advantage (size) in linking the .svg file in the .md file (as opposed to .png), but not all advantages. So, ideally, you’d replace the Visio file entirely with an editable .svg, if that is feasible. Worst-case, if Visio can’t export an .svg which can be edited by say Draw.io, you have two choices. Leave things as-is, or redraw the diagrams in editable .svg. It’s really a judgement call. It might be better to just use your time to produce new drawings this way and leave things as-is.

I don't mean to be pedantic about this, I'd just advise going forward we keep these things in mind. There are a lot of open-source project with complex .png files embedded in them, whose original source is probably on someone's hard drive, never to be found.

[lguohan]

better to keep as markdown format.

[KrisNey-MSFT]

Obsolete