Skip to content

overview: render project snippets with deliverable type and summary text#685

Merged
erictapen merged 2 commits into
ngi-nix:mainfrom
erictapen:overview-project-listing
Mar 28, 2025
Merged

overview: render project snippets with deliverable type and summary text#685
erictapen merged 2 commits into
ngi-nix:mainfrom
erictapen:overview-project-listing

Conversation

@erictapen
Copy link
Copy Markdown
Contributor

For now I'd only show the type of existing deliverables and the summary text if existent.

tmp kCljCTf0fn

eljamm
eljamm previously approved these changes Mar 27, 2025
Copy link
Copy Markdown
Contributor

@eljamm eljamm left a comment

Choose a reason for hiding this comment

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

This looks very cool. Thanks!

Comment thread overview/default.nix
@erictapen erictapen force-pushed the overview-project-listing branch from 44cf769 to 25a2d4b Compare March 27, 2025 17:05
Comment thread overview/default.nix Outdated
'') projects
);
project:
optionalString (project.packages != { }) (one "Executable")
Copy link
Copy Markdown
Contributor

@fricklerhandwerk fricklerhandwerk Mar 28, 2025

Choose a reason for hiding this comment

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

Suggested change
optionalString (project.packages != { }) (one "Executable")
optionalString (project.packages != { }) (one "program")

That corresponds to the module subtree, we may or may not want to keep around that terminology.

Later we can even reasonably leave that in plural, and then display a number to indicate how many there are -- it may be multiple, but AFAIK we don't have that case yet.

This may be an arbitrary nit, but I prefer to leave it not capitalised since there's no reason to (it's not the start of a sentence or anything of that kind), and if you really care I think this can be fixed in CSS.

But this is surely worth a good debate on naming, because both "program" and "executable" don't say much about the difference to "service". Maybe "command" would be more suitable, since you issue that deliberately to run an executable as opposed to a an executable being started automatically to run as a service.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I'm not even sure where I got these four categories from, but I also used these in #575.

I don't care much about how we call them currently, as we get the data right from the model and changing the implementation is still easy. So let's go with program for now. We might stumble over better terms through talking with users/explaining NGIpkgs to them.

Copy link
Copy Markdown
Contributor

@fricklerhandwerk fricklerhandwerk left a comment

Choose a reason for hiding this comment

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

Nice, except for the bikeshed.

@erictapen erictapen dismissed stale reviews from fricklerhandwerk and eljamm via a003796 March 28, 2025 10:32
@erictapen erictapen force-pushed the overview-project-listing branch from a003796 to 9fc4564 Compare March 28, 2025 10:33
@erictapen erictapen enabled auto-merge (squash) March 28, 2025 10:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants