Meshery: [Docs] Getting Started with Other Platforms

Created on 12 Aug 2020  ·  20Comments  ·  Source: layer5io/meshery

Current State:
The Getting Started with Other Platforms page currently has a table full of a list of platforms. It does not have platform logos included. Included the platform logo will improve legibility (readers eyes snap to the log) and readers will enjoy this table a bit more. - https://meshery.layer5.io/docs/installation/platforms

Screen Shot 2020-08-11 at 6 33 28 PM

Desired State:

  • [ ] Similar to the Meshery Adapters table, the Supported Platforms table should include small platform logos (ideally in SVG format) included in each row of the table.
  • [ ] The platform table in the Meshery repo README.md should also have this same set of platform logos.

Screen Shot 2020-08-11 at 6 34 37 PM

Logos:


Contributor Resources

aredocs first-timers-only good first issue help wanted kinenhancement languaghtml languagmarkdown

All 20 comments

Good day, I would like to contribute to this. I will love to ask if there's a specific place, where I can get the logos from?

@LifeofDan-EL thanks. That would be great. Unfortunately, no, we don't have a collection of these logos just, yet. We'll need to do some digging. I'll do this now...

Okay, if you can do that, I could add the logos under the assets file directory, for easier reference.

@LifeofDan-EL ok, good to go. All logos except Scoop (it doesn't have one) have been added to the issue description.

Thanks will work on it then.

Just to be clear, the table here should also have the logo right?
image

Right on, yes.

I made a PR https://github.com/layer5io/meshery/pull/1386, so I can easily use the GIthub url for the issue.

@LifeofDan-EL Thank you. When you do use the image URLs, it might be best to use their relative path, for example: <img src="/docs/assets/img/providers/provider_screenshot.png" alt="Providers">.

PR #1386 uses the keyword fixes which will automatically close this issue when it is merged. Given that it is only a portion of the complete fix, if you update the PR description to use a different word like "addresses" or "supports" or "relates to", then GitHub won't automatically close this issue.

So this is what the Readme and Platform look like now, I used the URL from the GitHub location of the images. It loads faster and to make sure it works locally and remote.
How does it look? Any suggestion
plaforms
tw

@LifeofDan-EL it looks pretty good. We lose a little of the indentation, it seems.

Relative URLs work both locally and remotely. There's no difference in load time after the PR is merged (they load from the same place). Relative URLs are less fragile.

We're missing a logo for Linux. Here you go - linux.svg.zip

We're missing a logo for Windows. You can use the same logo that is provided for WSL 2.

We're missing a logo for Mac. Here you go - apple.svg.zip

Added the new logos and I used relative URLs.
Readme

Awesome. 😄

Made a PR, it was fun working on this.

https://github.com/layer5io/meshery/pull/1390

Waow @LifeofDan-EL you make this look so easy. Let me find an issue to contribute to as soon as possible

Hi @leecalcote can we close this issue now?

About this, just checked https://meshery.layer5.io/docs/installation/platforms and the images there are broken but the readme I worked on is working well. Any idea why this is so?
df

No idea why, but i think it will be looked into. See #1395

Thanks @PluckyPrecious I leave it in good hands. I'm always available to help.

You rock @LifeofDan-EL. ✊🏽 Kindly check other issues in the repo, it sure will need your magic touch.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

navendu-pottekkat picture navendu-pottekkat  ·  4Comments

leecalcote picture leecalcote  ·  4Comments

leecalcote picture leecalcote  ·  3Comments

leecalcote picture leecalcote  ·  4Comments

leecalcote picture leecalcote  ·  4Comments