[Docs] Improve the docs for Consul adapter

[leecalcote]

Current State:
The meshery-consul docs are missing a description of many of the capabilities of the adapter.

Desired State:
The docs should be well-written and robust.

---

Contributor Resources

• Meshery documentation site
• Meshery documentation source
• Instructions for contributing to documentation

[leecalcote]

An improvement made. More to come.

[jomefavourite]

I'll like to take this up, but I'm not clear on what to add to the Doc

[PluckyPrecious]

Sure @jomefavourite do go ahead 👍🏽

[jomefavourite]

Sure @jomefavourite do go ahead 👍🏽

A guide will be helpful, on what to include into the Document

[mgfeller]

@jomefavourite that's great!

I don't think a guide on what to include into adapter documentation exists (yet).

A couple of thoughts and suggestions:

A good start could be to look at the documentation of the other adapters and related issues, and this one, and consider whether it tells enough to understand the adapters capabilities on both a high level, and a more detailed level. It's good not to duplicate information unless an include mechanism can be used.

A good start would also be to run meshery and install the consul mesh and sample application, and assess whether the documentation tells you what you might like to know. Also, is the documentation in sync with the adapter and the adapters UI? Does the documentation mention something you can't find in the UI?

Should we have a list of all install options, sample applications, and a short explanation for each?

I think it would be useful to have links to the service mesh homepage, and that the terminology is correct.
For instance, the Consul service mesh is called Consul Connect (https://www.consul.io/docs/connect).

The documentation should also be pleasing to look at :-)

For me, the images included here https://meshery.layer5.io/docs/service-meshes/adapters/consul appear too big, and maybe they shouldn't be included at all, rather pointing to the related documentation.

[jomefavourite]

@mgfeller wow that's a lot. I'll see what I can do. Thanks for the briefing

[mgfeller]

All improvements are welcome 👍

Personally, I think I would have started by including links to Consul Connect homepage, replaced the figures with links and a little bit of text to the original material, and possibly include a list with the mesh install preset (just one for the time being: "Consul Connect: unsecured, 1 server, suitable for local exploration").

[mgfeller]

Hi @jomefavourite, there are some guidelines about documenting adapters here https://docs.google.com/document/d/1b8JAMzr3Rntu7CudRaYv6r6ccACJONAB5t7ISCaPNuA/edit?ts=5f6639df#heading=h.1a405ofum9ao - I forgot about them, sorry. Please let me know if I can help.

[jomefavourite]

I feel this is beyond me, and not really still sure of what to do. Ill unassign myself

[mgfeller]

No problem, @jomefavourite There are plenty of issues with more detailed descriptions, e.g. https://github.com/layer5io/meshery/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22

[jomefavourite]

Okay thanks