overview: render service demos by erictapen · Pull Request #668 · ngi-nix/ngipkgs

erictapen · 2025-03-26T11:01:52Z

This is a first draft of the user-facing side of #614. As we don't have set on a virtualisation solution yet, it contains a lot of place holders.

My goal is to refine this step by step as things fall into place, so it's not exactly ready for review, but I welcome your comments.

eljamm · 2025-04-07T16:55:00Z

      ln -s ${fonts} $out/fonts
    ''
-    + (concatLines (mapAttrsToList (path: v: writeHtmlCommand path (htmlFile path v)) pages))
+    + (concatLines (mapAttrsToList (path: page: writeProjectCommand path page) pages))


This will also generate the top-level index.html file in a directory called index.html, which isn't what we want, probably

$ ls -lR result/ lrwxrwxrwx - root 1 Jan 1970  fonts -> /nix/store/x5vwknlmicp3wq2z7vqimsz8agyfc1qy-fonts dr-xr-xr-x - root 1 Jan 1970  index.html dr-xr-xr-x - root 1 Jan 1970  project .r--r--r-- 9.2k root 1 Jan 1970  style.css result/index.html: .r--r--r-- 15k root 1 Jan 1970  index.html

Good catch! Fixed that.

erictapen · 2025-04-18T11:28:17Z

This should probably be merged before the Nix install workflow is ready, as #698 depends on the default.nix files generated in this.

erictapen · 2025-04-18T15:23:14Z

fricklerhandwerk

Nice, just a bunch of text nits for now. The fewer additional words the better here; the demo works and that should speak for itself.

Let's get this out the door

fricklerhandwerk · 2025-04-18T16:47:01Z

+
+      machine.wait_for_unit("cryptpad.service")
+      machine.wait_for_unit("nginx.service")
+    '';


Run curl to make sure it's alive?

Done, though I have to admit I never ran this before.

fricklerhandwerk · 2025-04-18T16:48:41Z

 jinja2_template_file = sys.argv[1]
 output_file = sys.argv[2]


I can imagine this to be somewhat more natural if it read from stdin and wrote to stdout, but that's maybe cleanup for later.

True, but currently the script needs the dirname of the output file to read code samples.

fricklerhandwerk · 2025-04-18T16:55:29Z

+        <p>
+        Services utilising the NixOS module system generally only run on NixOS.
+        If you want to see a quick demo of this project, follow these steps to
+        run a preconfigured and tested KVM image on your system.
+        </p>
+


Suggested change



Services utilising the NixOS module system generally only run on NixOS.

If you want to see a quick demo of this project, follow these steps to

run a preconfigured and tested KVM image on your system.



I'd even go as far as saying we don't need to explain anything here. The heading already says what will happen. (We may want to note that you need virtualization enabled though, but more like in a foot note in case it's hyper slow.)

fricklerhandwerk · 2025-04-18T17:09:44Z

+            {{ include_code("nix", "default.nix", relative_path=True) }}
+          </li>
+          <li>
+            <strong>Build the VM start script</strong> defined in <code>default.nix</code> and run it:


Suggested change

Build the VM start script defined in <code>default.nix</code> and run it:

Build the virtual machine defined in <code>default.nix</code> and run it:

(It's the best kind of correct that we're actually building the wrapper script, but 🤫)

fricklerhandwerk · 2025-04-18T17:14:50Z

+            Building <strong>will</strong> take a while.
+          </li>
+          <li>
+            <strong>Access the service</strong> from a browser on your host:


Suggested change

Access the service from a browser on your host:

Access the service with a web browser:

Not sure if it's important to say you need to access it from your machine... can we safely assume that all operations are done on the same machine?

My idea was to communicate to people that there is some vm->host forwarding happening, but I guess people wouldn't try to start a webbrowser in the CLI only VM anyways.

fricklerhandwerk · 2025-04-18T17:19:13Z

+    demoGlue.one = exampleText: ''
+      # default.nix
+      {
+        ngipkgs ? import (fetchTarball "https://github.com/ngi-nix/ngipkgs/tarball/${self.rev or "main"}") { },


Hm not sure we want this right now. It will look needlessly noisy and provide no benefit. If we want to protect users from rebuilding everything the next day because we added commits, we should have a release branch instead. But that's for another time.

The motivation was to have people come back to a demo weeks later and it still works in the exact same way. Probably not so much of a benefit though.

imincik · 2025-04-25T06:59:07Z

@erictapen , are you able to resolve remaining review comments so we can merge this PR ? Thanks.

erictapen · 2025-04-25T10:19:11Z

@erictapen , are you able to resolve remaining review comments so we can merge this PR ? Thanks.

Yes, sorry for it taking so long. I should be through all your comments now, @fricklerhandwerk

erictapen requested review from eljamm, fricklerhandwerk and imincik March 26, 2025 11:01

github-project-automation Bot added this to Nix@NGI Mar 26, 2025

erictapen force-pushed the overview branch from f057bd1 to c8099d1 Compare March 26, 2025 16:52

imincik moved this to Needs refinement in Nix@NGI Mar 31, 2025

erictapen force-pushed the overview branch from c8099d1 to e9287a4 Compare April 1, 2025 13:29

eljamm reviewed Apr 7, 2025

View reviewed changes

imincik moved this from Needs refinement to In review in Nix@NGI Apr 8, 2025

imincik moved this from In review to In progress in Nix@NGI Apr 8, 2025

erictapen force-pushed the overview branch 2 times, most recently from f19f800 to 8a9b4ff Compare April 18, 2025 10:17

erictapen changed the title ~~overview: render service demos~~ overview: render service demos without Nix install instructions for now Apr 18, 2025

erictapen force-pushed the overview branch from b352792 to 4c86796 Compare April 18, 2025 11:25

erictapen marked this pull request as ready for review April 18, 2025 11:28

erictapen force-pushed the overview branch from 3f327fc to f4686f4 Compare April 18, 2025 11:39

eljamm reviewed Apr 18, 2025

View reviewed changes

Comment thread overview/default.nix

erictapen force-pushed the overview branch from d30003b to b701e16 Compare April 18, 2025 16:25

fricklerhandwerk reviewed Apr 18, 2025

View reviewed changes

fricklerhandwerk previously approved these changes Apr 18, 2025

View reviewed changes

imincik linked an issue Apr 25, 2025 that may be closed by this pull request

Implement demo instructions on the overview site #697

Closed

eljamm mentioned this pull request Apr 25, 2025

Implement demo instructions on the overview site #697

Closed

erictapen dismissed fricklerhandwerk’s stale review via e56721d April 25, 2025 09:53

erictapen added 4 commits April 25, 2025 12:13

overview: render service demos

593ef0e

overview: make code elements scrollable, not overflowing

d1bf027

overview: don't have comments in demo example

5461bb9

overview: note about demos taking a long time to build

6d1238d

erictapen added 11 commits April 25, 2025 12:13

overview: add back syntax highlighting

e9eb69b

overview: add syntax highlighting for examples too

0a933cf

overview: fix formatting

8728c44

overview: load all project services for the demo evaluation

97f936b

overview: provide exact git revision for demo fetchTarball

4a554f5

overview: remove dead import

8a1b693

overview: move anchor content to CSS

f31af18

Cryptpad: test demo with curl

636b50b

overview: remove demo explanation

1a398ae

overview: typo

232d5b9

overview: better wording

ced8976

erictapen force-pushed the overview branch from 7da1a06 to a05956a Compare April 25, 2025 10:13

overview: more review comments

b823c20

erictapen force-pushed the overview branch from a05956a to b823c20 Compare April 25, 2025 10:18

fricklerhandwerk approved these changes Apr 25, 2025

View reviewed changes

fricklerhandwerk changed the title ~~overview: render service demos without Nix install instructions for now~~ overview: render service demos Apr 25, 2025

fricklerhandwerk merged commit 5088191 into ngi-nix:main Apr 25, 2025
2 checks passed

github-project-automation Bot moved this from In progress to Done in Nix@NGI Apr 25, 2025

eljamm mentioned this pull request Nov 10, 2025

chore: Update CHANGELOG.md eljamm/ngipkgs#639

Closed

ngi-nix-bot mentioned this pull request Nov 11, 2025

chore: Update CHANGELOG.md #1786

Merged

ngi-nix-bot mentioned this pull request Dec 1, 2025

chore: Update CHANGELOG.md #1861

Merged

ngi-nix-bot mentioned this pull request Mar 1, 2026

chore: Update CHANGELOG.md #2226

Open

	<strong>Build the VM start script</strong> defined in <code>default.nix</code> and run it:
	<strong>Build the virtual machine</strong> defined in <code>default.nix</code> and run it:

	<strong>Access the service</strong> from a browser on your host:
	<strong>Access the service</strong> with a web browser:

Conversation

erictapen commented Mar 26, 2025

Uh oh!

eljamm Apr 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

erictapen commented Apr 18, 2025

Uh oh!

erictapen commented Apr 18, 2025

Uh oh!

Uh oh!

fricklerhandwerk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

imincik commented Apr 25, 2025

Uh oh!

erictapen commented Apr 25, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

eljamm Apr 7, 2025 •

edited

Loading