exercism / ocaml

Exercism exercises in OCaml.
https://exercism.org/tracks/ocaml
MIT License
94 stars 50 forks source link

Ensure OCaml track is ready for v2 launch #259

Closed kytrinyx closed 6 years ago

kytrinyx commented 6 years ago

There are a number of things we're going to want to check before the v2 site goes live. There are notes below that flesh out all the checklist items.

Track landing page

The v2 site has a landing page for each track, which should make people want to join it. If the track page is missing, ping @kytrinyx to get it added.

Blurb

If the header of the page starts with TODO, then submit a pull request to https://github.com/exercism/ocaml/blob/master/config.json with a blurb key. Remember to get configlet and run configlet fmt . from the root of the track before submitting.

About section

If the "About" section feels a bit dry, then submit a pull request to https://github.com/exercism/ocaml/blob/master/docs/ABOUT.md with suggested tweaks.

Formatting guidelines

In order to work well with the design of the new site, we're restricting the formatting of the ABOUT.md. It can use:

Additionally:

Code example

If the code example is too short or too wide or too long or too uninteresting, submit a pull request to https://github.com/exercism/ocaml/blob/master/docs/SNIPPET.txt with a suggested replacement.

Exercise metadata

Where the v1 site has a long, linear list of exercises, the v2 site has organized exercises into a small set of required exercises ("core").

If you update the track config, remember to get configlet and run configlet fmt . from the root of the track before submitting.

Topic and difficulty

Core exercises unlock optional additional exercises, which can be filtered by topic an difficulty, however that will only work if we add topics and difficulties to the exercises in the track config, which is in https://github.com/exercism/ocaml/blob/master/config.json

Auto-approval

We've currently made any hello-world exercises auto-approved in the backend of v2. This means that you don't need mentor approval in order to move forward when you've completed that exercise.

Not all tracks have a hello-world, and some tracks might want to auto approve other (or additional) exercises.

Track mentors

There are no bullet points for this one :)

As we move towards the launch of the new version of Exercism we are going to be ramping up on actively recruiting people to help provide feedback. Our goal is to get to 100%: everyone who submits a solution and wants feedback should get feedback. Good feedback.

If you're interested in helping mentor the track, check out http://mentoring.exercism.io/

# When all of the boxes are ticked off, please close the issue.

Tracking progress in https://github.com/exercism/meta/issues/104

jackhughesweb commented 6 years ago

Things that can be already checked off:

The track has a page on the v2 site: https://v2.exercism.io/tracks/ocaml The code example gives a good taste of the language and fits within the boundaries of the background image Exercises have rough estimates of difficulty

I've submitted a couple of pull requests for about #261 and a blurb/description #262 (which are dependant on #258 #260 being merged first, and my PRs will need to be fixed before merging).

Also, there are some things that need to be fixed with the exercises in config.json (once #258 is merged):

I'm happy to go through and add topics/set core exercises etc, although if anyone in @exercism/ocaml wishes to have a go at these please let me know (to avoid duplicating work) 😄