Markdown block: move support link away from description

[simison]

According to Gutenberg handbook, descriptions should be kept simple.

Even though our way of adding the support link directly in description works now (at least for desktop), we should keep description semantically free from custom UI. I'd imagine description popping up in different part sof the UI in future, especially for mobile clients.

Basically, this isn't visually as nice but semantically more correct.

Before

After

Changes proposed in this Pull Request

• Move support link from description to block inspector.

Testing instructions

• Spin up Jetpack site gutenpack-jn, connect jetpack and enable markdown module
• Add markdown block to a Gutenberg post
• Note support link in the sidebar when block is selected

[matticbot]

Test live: https://calypso.live/?branch=update/markdown-block-support-link

[tyxla]

This is a great little change 👍I claim this also looks better than before. Thanks!

Tests well and looks good 🚢

[mapk]

This change is executed nicely, but I'm still not a big fan. While the Gutenberg docs recommend against long descriptions and branding in this section, I don't think having a link there conflicts with that.

The description area "describes" the block and if the user doesn't know much about that, the link provides more description elsewhere. They seem to go well together.

With the link now in its own section, I begin to feel like its lacking validation for this. My vote is to keep it the way it was, but I'm open to the change.

[simison]

We could adjust CSS to make it look again like it used to, while keeping the "description" field free from any HTML.
@mapk Would that work?

In fact I think I'll move this to be shared component so I can re-use it with Simple Payments and other block.

[MichaelArestad]

I think it was better before. Adding it as it's own metabox seems to feel fairly disconnected.

[simison]

Adding it as it's own metabox seems to feel fairly disconnected.

You're totally right.

How about with little CSS tweak:

Best of both worlds — semantically correct in code and visually as it was before. :-)

Technically it's still its own section and I've just removed the border and adjusted margin.

[tyxla]

My opinion is that if we are to hack our way to make it look as part of the description, actually keeping it a part of the description makes more sense.

[tyxla]

Now there is where it feels off 😕

[simison]

Hehehe agreed with this too. :-) Non-ideal solutions all around!

[simison]

Closing; I think this was enough of an exploration into what we could have and it's a pity there isn't an ideal solution.

Let's hope we'll get official declarative support for documentation links later on:
WordPress/gutenberg#11330

Let's also make sure that all our blocks add support links in exact same way to stay consistent.