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

Introduce a tools section for platform page, releases page, and a news section for changelog, OCaml Planet and Newsletters #2410

Merged
merged 15 commits into from
May 22, 2024

Conversation

sabine
Copy link
Collaborator

@sabine sabine commented May 6, 2024

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 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 Platform Tools pages are now discoverable through the top level navigation
  • Redirects for the moved Platform pages are set up
  • Changelog, OCaml Planet, and Newsletters page now live under a "News" area
  • Resolves Documenting the compiler release cycle? #1985 by adding a new page "The Compiler Release Cycle"
page before after
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
Platform Tools Screenshot 2024-05-17 at 18-33-51 OCaml Platform Screenshot 2024-05-17 at 18-33-55 OCaml Platform
Top level nav News/Blog Screenshot 2024-05-15 at 17-35-37 OCaml Blog Screenshot 2024-05-15 at 17-35-42 OCaml Changelog
OCaml Planet Screenshot 2024-05-15 at 17-35-37 OCaml Blog Screenshot 2024-05-15 at 17-35-46 The OCaml Planet

cuihtlauac pushed a commit that referenced this pull request May 7, 2024
sabine pushed a commit that referenced this pull request May 7, 2024
…2412)

* Extract markdown processing from PR #2410

* Also import Toc and Search

---------

Co-authored-by: Cuihtlauac ALVARADO <cuihtmlauac@tarides.com>
@sabine
Copy link
Collaborator Author

sabine commented May 7, 2024

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 sabine marked this pull request as ready for review May 13, 2024 07:22
@sabine sabine changed the title Introduce a tools section for platform page, changelog, releases Introduce a tools section for platform page, releases page, and a news section for changelog, OCaml Planet and Newsletters May 13, 2024
Copy link
Collaborator

@tmattio tmattio 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 a very clear improvement to me!

The only nitpick I have is to keep the Playground/Play terminology, as I suspect the OCaml Playground has become something that people talk about in those terms.

@cuihtlauac
Copy link
Collaborator

cuihtlauac commented May 14, 2024

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

@sabine
Copy link
Collaborator Author

sabine commented May 14, 2024

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
Copy link
Collaborator Author

sabine commented May 14, 2024

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

@cuihtlauac
Copy link
Collaborator

@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
Copy link
Collaborator

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:

Does it fit into “Newsletters”?

@sabine
Copy link
Collaborator Author

sabine commented May 15, 2024

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 sabine force-pushed the tools_section branch 2 times, most recently from e0aa99d to 3f0c515 Compare May 15, 2024 15:40
@sabine
Copy link
Collaborator Author

sabine commented May 22, 2024

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 sabine merged commit 610c066 into ocaml:main May 22, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documenting the compiler release cycle?
4 participants