Azure-devops-docs: Mermaid support is not universal - misleading/confusing documentation

Created on 30 Sep 2019  Â·  12Comments  Â·  Source: MicrosoftDocs/azure-devops-docs

This page (https://docs.microsoft.com/en-us/azure/devops/project/wiki/wiki-markdown-guidance?view=azure-devops) indicates that Mermaid is supported by the Wiki and shows an icon on the editing toolbar. This icon does not appear in my project's wiki and when I enter the specified syntax into a new wiki page, it is not interpreted, but shown verbatim.

Which is wrong: This page's assertion that Mermaid syntax is supported, or my project wiki's set-up?


Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Pri1 devops-collatech devopprod doc-bug

Most helpful comment

@steved0x @msebolt

Do we know what version this is going to be in OnPremise - I can't see it on our version (Version Dev17.M153.3) and it isn't particularly clear in the documentation when it was introduced from.

Apologies this is a closed question but seems the best place for clarification.

All 12 comments

@jamie-tillman Thank you for the feedback.

This features is still listed as a feature under development.

Assigning to the author to remove or clarify.

And so it is. Then it is good I reported this bug. Your documentation is incorrect. Please correct the bug so others don't waste their time looking for a feature that isn't there.

I am confused by the actions taken on this ticket. It appears to have been assigned, and then closed after being linked to another closed ticket from 2 weeks ago. If you had addressed THAT ticket, mine would have been unnecessary.

The feature is in the process of deployment. It should be available in your account in a couple of weeks time.

@adramasu Thank you for the update, and @jamie-tillman sorry that you ran into trouble. I did a quick check and see that the Mermaid syntax is not in my personal accounts (the ones I checked anyway) and is in the one work account that I did check, so it appears to be rolling out. Let me see if I can get any more information and I will report back.

Concerned. Is it common practice for your docs to remain out of sync with
deployed code for weeks at a time? You've already received two independent
bug reports, indicating this is causing confusion.

On Tue, Oct 1, 2019 at 8:39 AM Adithya Ramasubramanian <
[email protected]> wrote:

The feature is in the process of deployment. It should be available in
your account in a couple of weeks time.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/MicrosoftDocs/vsts-docs/issues/5788?email_source=notifications&email_token=AMRF2TJMUX7SOSL6OHKUSHDQMNAIJA5CNFSM4I33FNW2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEABDWBI#issuecomment-537017093,
or mute the thread
https://github.com/notifications/unsubscribe-auth/AMRF2TKFLYBJBCPGNOGIK4TQMNAIJANCNFSM4I33FNWQ
.

--
Jamie Tillman / Chief Executive Officer & Lead Architect / www.Prolydian.com

Ok, thanks.

On Tue, Oct 1, 2019 at 9:00 AM Steve Danielson notifications@github.com
wrote:

@adramasu https://github.com/adramasu Thank you for the update, and
@jamie-tillman https://github.com/jamie-tillman sorry that you ran into
trouble. I did a quick check and see that the Mermaid syntax is not in my
personal accounts (the ones I checked anyway) and is in the one work
account that I did check, so it appears to be rolling out. Let me see if I
can get any more information and I will report back.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/MicrosoftDocs/vsts-docs/issues/5788?email_source=notifications&email_token=AMRF2TMOEFQBFUIFLCXJ5ALQMNCWJA5CNFSM4I33FNW2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEABFSPY#issuecomment-537024831,
or mute the thread
https://github.com/notifications/unsubscribe-auth/AMRF2TID32WXQXNY5DZXMC3QMNCWJANCNFSM4I33FNWQ
.

--
Jamie Tillman / Chief Executive Officer & Lead Architect / www.Prolydian.com

Concerned. Is it common practice for your docs to remain out of sync with deployed code for weeks at a time? You've already received two independent bug reports, indicating this is causing confusion.

Hi Jamie, it is not and we dropped the ball somewhere with the synchronization between this feature release and the documentation for that feature.

As soon as I get some more information, I'll get that note updated, and we'll keep this issue open until it is resolved, so that any other folks with the same question will more easily find this thread and see that the Mermaid feature is being rolled out and not available for all accounts just yet.

@jamie-tillman Mermaid support just appeared in my personal Azure DevOps Services account, so it might be in yours by now.

Also, we are developing a process of including a note in our docs with newly released features that includes a timeframe for rollout (that will be subsequently removed when we add the next batch from the next sprint) to try and avoid confusion like we did this time. Sorry again for the trouble, and thank you for your feedback.

It is in my account now, as well! I really appreciate the responsiveness of the team on this. It really raises my confidence in the platform. Not to mention the actual Mermaid support is almost like you guys read my mind. We've been having to embed diagram images until now. This was probably the only thing standing in the way of our full use of the wiki!

Hey, I've got the same problem and can't see the diagram button on the wiki page yet and its related syntax doesn't work as well. Is there any issue with version updating?

@steved0x @msebolt

Do we know what version this is going to be in OnPremise - I can't see it on our version (Version Dev17.M153.3) and it isn't particularly clear in the documentation when it was introduced from.

Apologies this is a closed question but seems the best place for clarification.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

adnanebrahimi picture adnanebrahimi  Â·  3Comments

MJECloud picture MJECloud  Â·  3Comments

KacperMucha picture KacperMucha  Â·  3Comments

sevaa picture sevaa  Â·  3Comments

kieronlanning picture kieronlanning  Â·  3Comments