Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update platform support #678

Merged

Conversation

straight-shoota
Copy link
Member

@straight-shoota straight-shoota commented Mar 28, 2023

Enhance information about minimum supported versions and limitations of lower-tier platforms.

Resolves crystal-lang/crystal#13170

@netlify
Copy link

netlify bot commented Mar 28, 2023

Deploy Preview for crystal-book ready!

Name Link
🔨 Latest commit 2a94707
🔍 Latest deploy log https://app.netlify.com/sites/crystal-book/deploys/642344c213d345000891ee3b
😎 Deploy Preview https://deploy-preview-678--crystal-book.netlify.app/syntax_and_semantics/platform_support
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.


| Target | Description | Supported versions |
| ------ | ----------- | ------------------ |
| `x86_64-darwin` | x64 macOS (Intel) | 11+<br> *(testing only on 11; expected to work on 10.7+)* |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can add a Comment column and move "expected to work on 10.7+" there, and remove the "testing only..." part?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And perhaps we could be consistent with the rest of the tables and add a ✅ build ✅ tests ✅ binaries (see below)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's relevant to mention which version we're actually testing on. We're currently not testing macOS 12 (crystal-lang/crystal#12570), so liability of this OS version is similar as for aarch64-darwin which is Tier 2.

Sure, we can add a Comment column here as well with the individual aspects. I just thought we can skip that because for Tier 1 everything needs to be ticked. Maybe it's more consistent that way...

Comment on lines 65 to 67
* ❌ means automated tests or builds are not available
* ✅ means automated tests or builds are available
* 🟡 means automated test are available, but the implementation is incomplete
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two stylistic suggestions: b/w icons and avoid the red cross as it suggests tests are failing, which is a stronger statement.

Suggested change
* means automated tests or builds are not available
* means automated tests or builds are available
* 🟡 means automated test are available, but the implementation is incomplete
* ◻︎ means automated tests or builds are not available
* ☑︎ means automated tests or builds are available
* means automated test are available, but the implementation is incomplete

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PS I don't know how these icons look in the page (but I know I don't like the current ones)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO the visuals fit very nicely with the rest of the page. Your suggested icons do not. I'll see if I can find some alternative suggestions.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the visuals fit very nicely with the rest of the page.

Not critical, but I disagree: the 3d looking icons do not match anything on that flat-looking page. Anyway, the most critical aspect to me is avoiding the red cross.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here are some suggestions for icon combinations:

grafik

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer coloured indicators for easy readability. I like the Unicode icons best for this, but unfortunately, the visuals are platform-specific and thus inconsistent. I could not recreate a decent coloured set with mkdocs icons (Temoji), they're inconsistent (the red circle is too big, the others are sitting too low).
Of these other alternatives, I think Material circles and Material checkbox circles are looking best.

Another option would be to use coloured icons via different means (for example directly embedded images or SVGs). This would make the source a bit nasty but IMO has the best results.

Copy link
Member

@beta-ziliani beta-ziliani Mar 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For reference, this is what I see (c'mon Apple!)
image

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the Material Circle. I think it gives a quick visual clue: empty, half, full, easy peasy

Copy link
Member Author

@straight-shoota straight-shoota Mar 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, it looked good but didn't work out well in practice. In the tables it looked too much like checkboxes and was asking to be clicked 😆

So I came up with a small modification, and I'm quite happy with it. The empty circle has a dashed line to symbolize absence and the full circle has a check mark in it to symbolize success. Also I changed the fill ratio of the partial circle to 5/8 which looks more pleasant than a clean 4/8.
grafik

docs/syntax_and_semantics/platform_support.md Outdated Show resolved Hide resolved
docs/syntax_and_semantics/platform_support.md Outdated Show resolved Hide resolved
Copy link
Member

@beta-ziliani beta-ziliani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is perfect, thanks @straight-shoota for your attention to details! Let's make a new PR promoting musl to Tier 1 🚀

@straight-shoota straight-shoota merged commit febc45b into crystal-lang:master Mar 30, 2023
@straight-shoota straight-shoota deleted the feature/platform-support branch March 30, 2023 12:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[RFC] Platform support
2 participants