New landing page #37

leostera · 2024-09-19T02:04:13Z

Not much to see here yet, just started drafting this page.

Moved us to MLX so its easier to see the final output of the page, and started using the dev preview to build this website. Works great!

The workflow is pretty annoying, since I have to run a while true; do dune exec sandworm -- ...; done and a separate server, and then manually reload the browser on every change.

This would be super smooth with something like astro.build but I want to honor the code we've written in OCaml so far – HOWEVER, there's a few things that'd be a lot better if we reused from JS world, like live-reloaders for styles.

I'm also using tailwind css.

This is based off the designs from Claire, with some content/structure adjustments based off Go's and Bun's websites.

Ref: https://www.figma.com/design/vSRUcQqOVTmRZqF1tD2Ov5/Dune-Download-Website?node-id=11-3&node-type=frame&t=LFqNbmPvTj45pZVv-0

leostera · 2024-09-19T02:04:55Z

Also yes I am quite jetlagged.

leostera · 2024-09-19T13:32:39Z

Some more changes here:

assume all releases have commit + certificate, we don't really care about older ones
add a install script based off bun.sh
prioritize a quick start but still show how to manually install + verify
make room for a FAQ section

leostera · 2024-09-19T13:33:50Z

Updated screenshot:

leostera · 2024-09-19T14:00:39Z

sandworm/lib/metadata.ml

-    ; has_certificate : (bool[@default false])
-    ; commit : (string option[@default None])
+    ; has_certificate : bool [@default false]
+    ; commit : string [@default "-"]


@maiste would love to remove this default, just need to clean up the .json file so we drop all the old releases that don't have this info.

Same for has_certificate – we can drop all old releases without certificates

Honestly, if we restart the website, we can definitely just replace the content of metadata.json by []. This way, we don't have to worry about what we should keep or not. We can consider this as a "fresh start" 👍

leostera · 2024-09-19T14:05:17Z

sandworm/lib/web1.mlll

I'll remove this file before we merge.

maiste

This is a first batch of review, I'll focus on the HTML and testing tomorrow 👍
I still believe we shouldn't push the dune.lock as it is not considered to be portable (in the current situation).

maiste · 2024-09-19T16:03:36Z

install

+    ;;
+'Linux x86_64' | *)
+    target=x86_64-unknown-linux-musl
+    ;;


Shouldn't we display an error instead and quit with it is not supported? Otherwise, people might install something that will not work on their system...

maiste · 2024-09-19T16:13:04Z

install

+install_dir=$HOME/.dune
+bin_dir=$install_dir/bin


Why not install it to ~/local/bin as many programs do? It would let you not having to touch the path :)

install

maiste · 2024-09-19T16:15:19Z

install

+case $(basename "$SHELL") in
+fish)
+    # Install completions, but we don't care if it fails
+    IS_dune_AUTO_UPDATE=true SHELL=fish $exe completions &>/dev/null || :


I may be mistaken, but I don't thunk we have completion, no?

Ah yes, remnants from the original bun.sh install script :D will remove.

maiste · 2024-09-19T16:26:40Z

install

+
+echo
+
+case $(basename "$SHELL") in


Instead of directly exporting, what do you think about asking the user? It would prevent people that tries to install the newer version to have the export multiple times and also change the location for the people who want. WDYT?

maiste · 2024-09-19T16:29:07Z

sandworm/lib/metadata.ml

+  let create ~date ~commit targets =
+    { date; targets; commit; has_certificate = true}


If you turn the metadata.json into a clean version, I think you can simply remove the has_certificate 👍

maiste · 2024-09-19T16:30:04Z

sandworm/sandworm.opam

Could you regenerate this opam file, on my machine it says it's different? :D

maiste · 2024-09-19T16:30:31Z

yarn.lock

Could you remove this file? I don't think we need it in our context, no?

maiste · 2024-09-19T16:31:01Z

sandworm/dune-project

-          (ocaml-lsp-server :with-dev-setup)
-          (ocamlformat :with-dev-setup)))


Why not keep them?

Ah, I forgot I removed this :)

maiste · 2024-09-19T16:31:57Z

sandworm/.gitignore

Couldn't it be in the general .gitignore instead?

maiste · 2024-09-20T08:49:48Z

For the header, what do you think about adding more margin to the left and to the right, as in ocaml.org? It's definitely an aesthetic question, though.

maiste

And here is the second round about the web page 😸

sandworm/lib/web.mlx

maiste · 2024-09-20T08:54:41Z

sandworm/lib/web.mlx

+      <pre>
+"
+$ dune init proj hello_world
+$ cd hello_world
+$ dune pkg lock
+$ dune exec hello_world
+"
+      </pre>


For the sake of readability, I would add a background to this. Uniformity is good, and you already put a gray background to the curl cmd.

maiste · 2024-09-20T08:57:15Z

sandworm/lib/web.mlx

+let faq () =  
+  <section id="faq" class_="flex flex-col py-10 gap-2">
+    <h2 class_="text-3xl font-black pb-4"> "Frequently Asked Questions" </h2>
+  </section>


One answer we can put it is the fact that they are unstable. It's most to protect us against any unsatisfied user 😄

maiste · 2024-09-20T08:58:15Z

sandworm/lib/web.mlx

+      <a class_="text-[var(--accent)]">"Download"</a>
+      <a>"Cert"</a>


Is it a choice, or is it a forgetting to not have put the link here?

Just forgot :) will add now.

maiste · 2024-09-20T09:00:01Z

sandworm/lib/web.mlx

+            let (y,m,d) = bundle.date in
+            Format.sprintf "nightly-%d-%d-%d" y m d


This function could be transferred to module Bundle. The smallest operation we do in the web file, the more readable it is (it was an issue in the previous design) 👍

maiste · 2024-09-20T09:45:34Z

sandworm/lib/web.mlx

+
+    <h2 class_="text-2xl font-medium pt-4 pb-2"> "Installing the binary" </h2>
+    <p>
+      "After downloading a binary release of Dune, make it executable and place it somewhere reachable by your PATH:"


It could be nice to use a way to emphasize the PATH variable, monospace font?

maiste · 2024-09-20T09:45:54Z

sandworm/lib/web.mlx

+    <p>
+      <span>"To ensure trust in the binary distribution, we generate a build certificate associated with the Github Actions pipeline where the binaries are built. Once you download this certificate, you can use the "</span>
+      <code>"gh"</code>
+      <span>"tool to verify it with the following command: "</span>


Suggested change

<span>"tool to verify it with the following command: "</span>

<span>" tool to verify it with the following command: "</span>

maiste · 2024-09-20T09:46:38Z

sandworm/lib/web.mlx

+      <span>"To ensure trust in the binary distribution, we generate a build certificate associated with the Github Actions pipeline where the binaries are built. Once you download this certificate, you can use the "</span>
+      <code>"gh"</code>
+      <span>"tool to verify it with the following command: "</span>


Maybe without span is here enough here. WDYT?

maiste · 2024-09-20T09:47:47Z

sandworm/lib/web.mlx

+  <html>
+    <head>
+      <meta charset="utf-8" />
+      <title> "Dune Developer Preview" </title>


What do you think about extracting the title in a variable? It would make it easier to change in the future (as at some point it will just be Dune Distribution). But maybe it's a problem for later.

maiste · 2024-09-20T09:49:01Z

sandworm/lib/web.mlx

You need to reintroduce the plausible script somewhere in this file. Otherwise, we would lose this metric 😢

Co-authored-by: Etienne Marais <dev@maiste.fr>

draft

636d039

draft install script from bun.sh/install

55bd0a5

leostera force-pushed the new-landing-page branch 2 times, most recently from b5df3c1 to 5ce70cc Compare September 19, 2024 13:28

first draft almost done

24b762d

leostera force-pushed the new-landing-page branch from 5ce70cc to 24b762d Compare September 19, 2024 13:29

leostera added 2 commits September 19, 2024 15:51

remove and ignore devtools locks

6536fac

fix typo in install script

8a06e04

leostera marked this pull request as ready for review September 19, 2024 13:59

leostera commented Sep 19, 2024

View reviewed changes

sandworm/lib/web1.mlll Outdated

Copy link

Contributor Author

leostera Sep 19, 2024

Choose a reason for hiding this comment

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

I'll remove this file before we merge.

maiste reviewed Sep 19, 2024

View reviewed changes

maiste reviewed Sep 20, 2024

View reviewed changes

Update sandworm/lib/web.mlx

4540ec2

Co-authored-by: Etienne Marais <dev@maiste.fr>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New landing page #37

New landing page #37

leostera commented Sep 19, 2024

leostera commented Sep 19, 2024

leostera commented Sep 19, 2024

leostera commented Sep 19, 2024

leostera Sep 19, 2024

leostera Sep 19, 2024 •

edited

Loading

maiste Sep 19, 2024

leostera Sep 19, 2024

maiste left a comment

maiste Sep 19, 2024

maiste Sep 19, 2024

maiste Sep 19, 2024

leostera Sep 20, 2024

maiste Sep 19, 2024

maiste Sep 19, 2024

maiste Sep 19, 2024

maiste Sep 19, 2024

maiste Sep 19, 2024

leostera Sep 20, 2024

maiste Sep 19, 2024

maiste commented Sep 20, 2024

maiste left a comment

maiste Sep 20, 2024

maiste Sep 20, 2024

maiste Sep 20, 2024

leostera Sep 20, 2024

maiste Sep 20, 2024

maiste Sep 20, 2024

maiste Sep 20, 2024

maiste Sep 20, 2024

maiste Sep 20, 2024

maiste Sep 20, 2024

		let create ~date ~commit targets =
		{ date; targets; commit; has_certificate = true}

		(ocaml-lsp-server :with-dev-setup)
		(ocamlformat :with-dev-setup)))

		<a class_="text-[var(--accent)]">"Download"</a>
		<a>"Cert"</a>

		let (y,m,d) = bundle.date in
		Format.sprintf "nightly-%d-%d-%d" y m d

	<span>"tool to verify it with the following command: "</span>
	<span>" tool to verify it with the following command: "</span>

		install_dir=$HOME/.dune
		bin_dir=$install_dir/bin


		echo

		case $(basename "$SHELL") in

New landing page #37

Are you sure you want to change the base?

New landing page #37

Conversation

leostera commented Sep 19, 2024

leostera commented Sep 19, 2024

leostera commented Sep 19, 2024

leostera commented Sep 19, 2024

Choose a reason for hiding this comment

leostera Sep 19, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maiste left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maiste commented Sep 20, 2024

maiste left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

leostera Sep 19, 2024 •

edited

Loading