Dvc.org: glossary: tooltips break details sections

[jorgeorpinel]

As a result of implementing #424, <abbr> tags now create glossary tooltips around certain terms in the docs.

However if one of these terms is placed inside a <details> section, the docs engine fails to create the expandable boxes (a pre-existing feature).

---

UPDATE: The example below is outdated but you get the idea hopefully.

For example open static/docs/user-guide/external-dependencies.md and change

### Expand to learn more about DVC internals

The resulting "import stage" DVC-file will contain something like this:

which looks

for

### Expand to learn more about DVC internals

The resulting <abbr>import stage</abbr> DVC-file will contain something like
this:

resulting in:

[jorgeorpinel]

@algomaster99 do you want to take a look at this? 🙂

[algomaster99]

@jorgeorpinel This is happening since it only detects the abbr tags and just ignores the details tag. Seems weird to me. I'll have to check the inner functioning of HtmlRenderer.

[jorgeorpinel]

When fixed:

• [x] We should add <abbr> to term "project" in the first <details> section of static/docs/get-started/configure.md, for now removed in ce3d940.
• [x] Re-add <abbr> in tags static/docs/get-started/add-files.md removed temporarily in ed4062e.
• [ ] Undo also 6d642ef.
• [x] And d28add6

[jorgeorpinel]

"Remember me @algomaster99" -This issue 🙂

[algomaster99]

@jorgeorpinel I think this would require some changes in react-markdown itself. I found one issue which is relevant - https://github.com/rexxars/react-markdown/issues/302

[fabiosantoscode]

I've opened this PR there which fixes this problem: https://github.com/rexxars/react-markdown/pull/386

[shcheklein]

@fabiosantoscode awesome, thanks.

[rogermparent]

With #1334 (maybe before?), this seems to be fixed for me:

@jorgeorpinel The "When fixed" list may also need to update to our current docs content.

• [ ] We should add <abbr> to term "project" in the first <details> section of static/docs/get-started/configure.md, for now removed in ce3d940.

Like this one, for example: we don't seem to have an glossary entry for "project"- did we change this term in the past? Oops, I forgot to port that term in another PR!

On a related note, I made #1357 because the test page threw a null error when I clicked a details on mobile without the change.

Anyway, once others confirm this is really fixed I think we'll want to draft up a new list of abbrs to add inside details and either add that to this issue or close this and make a new content-only one. Up to everyone's preference, really.

[rogermparent]

I'm working on fixing everything in the "When fixed" list, now that I realize it's current enough for me to figure it out and we aren't missing whole terms.