fsharp / fsharp.org

The F# Software Foundation website
https://fsharp.org
291 stars 276 forks source link

Update index.md to not suggest install-sh for mac #937

Closed baronfel closed 1 year ago

baronfel commented 1 year ago

This is a foot-gun - the install docs on learn.ms.com are more comprehensive and we really do not want users installing local versions of the SDK. It's inconsistent in a lot of small ways that I have to wrestle with day-to-day. If we did want to highlight CLI-based installs I'd rather suggest homebrew (even though the homebrew recipe is horrible because it doesn't support side-by-side).

vzarytovskii commented 1 year ago

Will it make sense to hide install script for both Mac and Linux under ghe details tag and mark it as a very advanced use case? I personally use install script all the time and have no issues, but it's indeed an advanced use case.

baronfel commented 1 year ago

No, don't think that's worth it. I think we should remove them entirely from this doc. This page is often used as someone's first intro to .net at all, and the first actionable thing is the shell code that puts them in an oddball state. People seem to skim over the link here and go right to the curl command 😅

smoothdeveloper commented 1 year ago

Maybe the page should point at Microsoft documentation, which would be up-to-date at all point.

I don't think removing is necessary because there are people (not a majority) that would use script/shell rather than clicking.

But if the same documentation about installing dotnet from shell is available on Microsoft, I think we can defer to it.

I understand there is underlying tension with fsharp.org not being tied to Microsoft, so maybe not applicable what I suggest.

baronfel commented 1 year ago

There are links in the first sentences of this section that point to the MS download page, which also links docs - which do also cover using the install scripts. My point is that the presence of a quick 'copy this' completely overrides the link - people see that curl command and assume it's right.

smoothdeveloper commented 1 year ago

thanks for bringing me on the same page @baronfel!

Not opposed moving this forward, I see it as less code, less bugs.