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

MPR#7647: emphasize ocaml.org links in readme #1384

Merged
merged 1 commit into from Oct 8, 2017

Conversation

Projects
None yet
2 participants
@yawaramin
Copy link
Contributor

yawaramin commented Sep 30, 2017

Link to appropriate pages in ocaml.org for the homepage, getting OCaml,
documentation, and discussion fora.

@gasche
Copy link
Member

gasche left a comment

In general I agree with the spirit of the change, but I don't agree with removing all mentions of the caml-list@inria.fr mailing-list from the README. The current status remains that the mailing-list is the sanctioned forum for community discussion, and the Discuss website is more of an experiment.

I think you should keep the part on the caml-list (the description, the adress, the archives), and mention Discuss only second. I would personally also keep the IRC channel in the description (it has a many-years track record of being actively used), before you redirect to the /community/ webpage for more details and other places.

Changes Outdated
@@ -24,6 +24,8 @@ be mentioned in the 4.06 section below instead of here.)

### Manual and documentation:

- PR#7647: emphasize ocaml.org website and forum in README

This comment has been minimized.

@gasche

gasche Sep 30, 2017

Member

If you want a Change entry, you should have a proper credit line like other entries.

This comment has been minimized.

@yawaramin

yawaramin Sep 30, 2017

Author Contributor

Ah, OK, done. I figured since this will be a user-facing change (?), it should have an entry.

This comment has been minimized.

@gasche

gasche Oct 7, 2017

Member

Yes, I agree that this deserves a Change entry!

@yawaramin yawaramin force-pushed the yawaramin:readme-ocaml-org branch from d6250fb to 55cdeb1 Sep 30, 2017

@yawaramin

This comment has been minimized.

Copy link
Contributor Author

yawaramin commented Sep 30, 2017

@gasche thanks for the review, I've reworded the section to add back the caml-list as the main forum, and also specifically pointed out the #ocaml channel.

@yawaramin

This comment has been minimized.

Copy link
Contributor Author

yawaramin commented Oct 7, 2017

Bumping this as I believe it will be genuinely helpful to newcomers.

README.adoc Outdated

The community also maintains the Web site http://ocaml.org, with tutorials
and other useful information for OCaml users.
http://ocaml.org/

This comment has been minimized.

@gasche

gasche Oct 7, 2017

Member

Can we give a more precise link to where the OCaml manual is? For caml.inria.fr, that would be http://caml.inria.fr/pub/docs/manual-ocaml/ (which points to versions in other formats as well). What is the corresponding ocaml.org link?

(http://caml.inria.fr/pub/distrib/ocaml-4.05/ would also be a natural choice of URL but it has the downside of being specific to an OCaml version, and we don't want to have to change the URL on each release; if we kept pointing at caml.inria.fr it would make sense to add a distrib/ocaml-latest directory. We should be careful of having the same release-robustness property on ocaml.org.)

This comment has been minimized.

@yawaramin

yawaramin Oct 7, 2017

Author Contributor

I didn't add more detail because the previous link was also to the old homepage, so it would take a user a similar number of clicks to reach the manual. If you feel it would help though, I can point directly to the manual, which of course remains at http://caml.inria.fr/pub/docs/manual-ocaml/

This comment has been minimized.

@gasche

gasche Oct 7, 2017

Member

Yes, please point to the manual directly (on caml.inria.fr or ocaml.org).

README.adoc Outdated

Messages to the list should be sent to:
The OCaml mailing list is the official forum for users of the OCaml
implementations developed at INRIA. You can email it at

This comment has been minimized.

@gasche

gasche Oct 7, 2017

Member

I would propose:

The OCaml mailing list is the longest-running forum for OCaml users. You can email it at

@yawaramin yawaramin force-pushed the yawaramin:readme-ocaml-org branch from 55cdeb1 to 65647f2 Oct 7, 2017

@yawaramin

This comment has been minimized.

Copy link
Contributor Author

yawaramin commented Oct 7, 2017

OK, branch updated with results of latest review.

@gasche

gasche approved these changes Oct 8, 2017

Changes Outdated
@@ -32,7 +32,9 @@ be mentioned in the 4.06 section below instead of here.)

### Manual and documentation:

### Compiler distribution build system:
- PR#7647: emphasize ocaml.org website and forum in README (Yawar Amin)

This comment has been minimized.

@gasche

gasche Oct 8, 2017

Member

Sorry for the endless nitpicking, but:

  • could you include GPR#1384 as well?
  • the credit line should be on its own line

This comment has been minimized.

@yawaramin

yawaramin Oct 8, 2017

Author Contributor

No worries, done and done :-)

MPR#7647: emphasize ocaml.org links in readme
Link to appropriate pages in ocaml.org for the homepage, getting OCaml,
documentation, and discussion fora.

@yawaramin yawaramin force-pushed the yawaramin:readme-ocaml-org branch from 65647f2 to 2f8fba5 Oct 8, 2017

@gasche gasche merged commit 8eef73e into ocaml:trunk Oct 8, 2017

0 of 2 checks passed

continuous-integration/appveyor/pr Waiting for AppVeyor build to complete
Details
continuous-integration/travis-ci/pr The Travis CI build is in progress
Details
@gasche

This comment has been minimized.

Copy link
Member

gasche commented Oct 8, 2017

Thanks! Merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.