ocaml.org icon indicating copy to clipboard operation
ocaml.org copied to clipboard

Introduce a tools section for platform page, changelog, releases

Open sabine opened this issue 9 months ago • 1 comments

I propose to restructure the site such that there is a dedicated Tools section in the top level navigation.

This patch

  • restructures the site to introduce a "Tools" section which currently contains the Platform Tools page, the Changelog and the Compiler Releases page.
  • splits the Platform section that previously existed in the Learn area into a part that lives in the new Tools section (the Platform page, as well as the accompanying non-learning-related documents), and the tutorials which stay within the Learn area. To achieve this, a new data/ kind tool_page has been added.
  • adds text on the Platform page to give more context about the lifecycle of the Platform Tools and moves the video to the bottom of the page
  • as a consequence of this restructuring, the non-learning-related Platform Tools documents no longer show up in the search results of the Learn area search
  • in the Platform section of the Learn area, we now use categories to separate the different tutorials by topic, instead of listing them all under "Best Practices"
  • Compiler Releases and Changelog pages are now discoverable through the top level navigation
  • Redirects for the moved Platform pages are set up
page before after
Platform Tools Screenshot 2024-05-06 at 22-52-03 OCaml Platform Screenshot 2024-05-06 at 22-51-55 OCaml Platform
Platform Section of the Learn Area Screenshot 2024-05-06 at 22-52-03 OCaml Platform Screenshot 2024-05-06 at 22-53-15 Bootstrapping a Project · OCaml Documentation

sabine avatar May 06 '24 20:05 sabine

Additional remark:

This could also be the place where a "Compiler" page could be introduced that explains the different targets and the tiers, and such.

sabine avatar May 07 '24 09:05 sabine

Regarding the https://ocaml.org/blog page, you are removing the news thing (on the right). Where is this content going?

cuihtlauac avatar May 14 '24 16:05 cuihtlauac

This is at the Newsletters subnav.

I think we could use a news overview page that provides a window into all the feeds the site has.

sabine avatar May 14 '24 17:05 sabine

@tmattio "Play" will fit, but "Playground" takes to much space unless we can make the "Get Started" button smaller.

sabine avatar May 14 '24 17:05 sabine

@tmattio "Play" will fit, but "Playground" takes to much space unless we can make the "Get Started" button smaller.

Why not “Start” and “Play” ?

cuihtlauac avatar May 15 '24 06:05 cuihtlauac

This is at the Newsletters subnav.

I think we could use a news overview page that provides a window into all the feeds the site has.

News also includes stuff like this:

  • https://ocaml.org/news/invitation-to-contribute
  • https://ocaml.org/news/sigplan_announcement
  • https://ocaml.org/news/2023-05-30-emissions-monitoring

Does it fit into “Newsletters”?

cuihtlauac avatar May 15 '24 06:05 cuihtlauac

News also includes stuff like this:

* https://ocaml.org/news/invitation-to-contribute

* https://ocaml.org/news/sigplan_announcement

* https://ocaml.org/news/2023-05-30-emissions-monitoring

Does it fit into “Newsletters”?

I think it does.

sabine avatar May 15 '24 15:05 sabine

I'm merging because I received no pushback in conversations I had about this, and because it will enable us to place a banner or other announcement for the Dune Developer Preview in a location that can be discovered from the main navbar.

Further refinement / rearrangement is still possible.

sabine avatar May 22 '24 12:05 sabine