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.

Sign up for GitHub

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

Jump to bottom

Update windows install instructions to opam #2658

Merged
merged 11 commits into from
Sep 6, 2024
Merged

Update windows install instructions to opam #2658

merged 11 commits into from
Sep 6, 2024

Conversation

Sudha247
Copy link
Contributor

@cuihtlauac
Copy link
Collaborator

@jonahbeckford: Can you review this please?

@jonahbeckford
Copy link
Contributor

Overall it looks good.

When I tried to install ocamlformat with opam 2.2 (unrelated to this PR), it failed. So it would be good to go through the site and see what works and what doesn't.

@jonahbeckford
Copy link
Contributor

Note: I'll submit a DkML PR for ocaml.org early next week. But it is best to get opam 2.2 properly documented on the website first.

@Sudha247
Copy link
Contributor Author

When I tried to install ocamlformat with opam 2.2 (unrelated to this PR), it failed. So it would be good to go through the site and see what works and what doesn't.

Indeed, I've been making some notes on the state of platform tools on Windows. I'll publish it on gist next week and find a more permanent place for it.

pirbo
pirbo suggested changes Aug 27, 2024
View reviewed changes
Copy link

@pirbo pirbo left a comment

Choose a reason for hiding this comment

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

Thanks @Sudha247. I'll duplicate my remark that I think we should move fast on this at the price of postponing instruction about the platform which is not there yet (and make our priority number 1 to fix that!)

src/ocamlorg_frontend/pages/install.eml Outdated Show resolved Hide resolved
src/ocamlorg_frontend/pages/install.eml Show resolved Hide resolved
dra27
dra27 reviewed Aug 28, 2024
View reviewed changes
Copy link
Member

@dra27 dra27 left a comment

Choose a reason for hiding this comment

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

Looking good, thank you! I agree with @pirbo that it would be better to get a version deployed quickly and then iterate on it - to that end, I'd suggest leaving the updates for 3_01_ocaml_on_windows.md to a subsequent PR.

data/tutorials/getting-started/1_00_install_OCaml.md Show resolved Hide resolved
src/ocamlorg_frontend/pages/install.eml Show resolved Hide resolved
src/ocamlorg_frontend/pages/install.eml Outdated Show resolved Hide resolved
src/ocamlorg_frontend/pages/install.eml Outdated Show resolved Hide resolved
src/ocamlorg_frontend/pages/install.eml Outdated Show resolved Hide resolved
src/ocamlorg_frontend/pages/install.eml Outdated Show resolved Hide resolved
@jonahbeckford
Copy link
Contributor

Edit: I'll do a PR to add back in DkML as a secondary option in mid-Sept. I'm +1 for getting this PR merged.

christinerose
christinerose reviewed Aug 30, 2024
View reviewed changes
Copy link
Collaborator

@christinerose christinerose left a comment

Choose a reason for hiding this comment

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

Looks like my previous commit to remove the repeated word was lost somehow, so I made a suggestion to do so this time instead of editing it directly.

@dra27
Copy link
Member

dra27 commented Sep 6, 2024

Is this able to be merged, please - it would be great to have the site up-to-date before tomorrow's ICFP workshop talks!

@cuihtlauac cuihtlauac merged commit 8b92a83 into ocaml:main Sep 6, 2024
3 checks passed
sabine pushed a commit to ggsmith842/ocaml.org that referenced this pull request Nov 29, 2024
@Sudha247 @dra27
@christinerose @sabine
Update windows install instructions to opam (ocaml#2658)
8b86c29 
* Update Windows install page to recommend opam 2.2

* Update the installation tutorial for Windows

* Merge the installation instructions

* Remove out-of-date user note

* Apply suggestions from code review

Co-authored-by: David Allsopp <[email protected]>

* remove repeated word

* link the opam blog for more info

* Update src/ocamlorg_frontend/pages/install.eml

Co-authored-by: Christine Rose <[email protected]>

---------

Co-authored-by: David Allsopp <[email protected]>
Co-authored-by: Christine Rose <[email protected]>
sabine pushed a commit to ggsmith842/ocaml.org that referenced this pull request Dec 10, 2024
@Sudha247 @dra27
@christinerose @sabine
Update windows install instructions to opam (ocaml#2658)
bdbb0e6 
* Update Windows install page to recommend opam 2.2

* Update the installation tutorial for Windows

* Merge the installation instructions

* Remove out-of-date user note

* Apply suggestions from code review

Co-authored-by: David Allsopp <[email protected]>

* remove repeated word

* link the opam blog for more info

* Update src/ocamlorg_frontend/pages/install.eml

Co-authored-by: Christine Rose <[email protected]>

---------

Co-authored-by: David Allsopp <[email protected]>
Co-authored-by: Christine Rose <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dra27 dra27 dra27 left review comments

@pirbo pirbo pirbo requested changes

@christinerose christinerose christinerose approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update install instructions on windows
6 participants
@Sudha247 @cuihtlauac @jonahbeckford @dra27 @pirbo @christinerose