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

Installation instructions: rework for all platforms #86

Merged
merged 18 commits into from Oct 17, 2019

Conversation

ftarulla
Copy link
Contributor

No description provided.

@bcardiff
Copy link
Member

@ftarulla I think I missed that Kubuntu should cover the same content as ubuntu. Official repo and linuxbrew options should be added aswell and it should be reordered between ubuntu and debian I guess. I'm sorry I didn't see that before.

Copy link
Member

@bcardiff bcardiff left a comment

Choose a reason for hiding this comment

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

It looks great 🚀

@bcardiff bcardiff merged commit f4a6879 into crystal-lang:unstable Oct 17, 2019
@straight-shoota
Copy link
Member

The paths don't work. Links are generated for /install/<platform> but the files are at /install/<platform>.html. I'm not sure if S3 can be configured to serve these files at a URL without the extensions.

Otherwise, the new pages need a permalink configuration (can be configured centrally in _config.yml).

@bcardiff
Copy link
Member

Yikes. How I missed that in stg. Thanks.

@straight-shoota
Copy link
Member

A few other notes regarding this change. I didn't get to review this properly before merging.

  • I'd reorder the platforms, put the most important ones first. Probably something like macOS, ubuntu, arch, alpine, wsl at the top. Sources and tar.gz should be last. And we should add Docker instructions. Bigger icons would also be nice.
  • It would be nice to have Edit this page links, directly linking to the edit page here on Github. Might be put under Found any issues?.
  • We need a /docs page that links to installation, API and language reference (cf Refer to the crystal book as "language reference" #57)
  • We need a proper Getting started guide with a short introduction to Crystal, which can be linked at "Done installing?" "Learn" sounds not very welcoming. Calling it "Getting started" is better.

@bcardiff
Copy link
Member

I wanted to minimize the amount of call for actions: next / problems.

If there are issues with the installation instructions per platforms I think is better to have a conversation in the forum rather than a PR in the website.

There are definitely more things to do: a better next step to start learning and a main docs page are still wanted.

PRs over this are welcome is not closed to keep evolving.

@bcardiff
Copy link
Member

Regarding the ordering, the criteria was to put first the distros/platforms with official distribution channels.

As long as the top 4 are the current ones: sources, targz, mac, ubuntu I am happy to accept other criteria.

@bcardiff
Copy link
Member

Platform detection and ordering based on global user base could be another option.

I wanted to have a clear menu for the users to pick their distro context and discover available options from there. And prevent them to go through ubuntu + snap + linuxbrew for example.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants