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

ROCK and chisselled ROCK tutorials have distracting diff #650

Open
cpaelzer opened this issue Jul 24, 2024 · 1 comment
Open

ROCK and chisselled ROCK tutorials have distracting diff #650

cpaelzer opened this issue Jul 24, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@cpaelzer
Copy link

Request type

Fix

What needs to get done

Hi,
the niceness on ROCKs and chiselling is that, as chisel slices already exist, they are as easy to use as parts already are.

The problem is that I'd consider it likely that users will do both tutorials after each other and they will wonder why there is so much difference.

diff -Naur hello/rockcraft.yaml chiselled-hello/rockcraft.yaml
--- hello/rockcraft.yaml	2024-07-24 11:58:58.630846588 +0200
+++ chiselled-hello/rockcraft.yaml	2024-07-24 11:57:55.547364572 +0200
@@ -1,20 +1,16 @@
-# Metadata section
-
-name: hello
-summary: Hello World
-description: The most basic example of a rock.
-version: "latest"
+name: chiselled-hello
+summary: Hello world from Chisel slices
+description: A "bare" rock containing the "hello" package binaries from Chisel slices.
 license: Apache-2.0
 
+version: "latest"
 base: bare
-build-base: ubuntu@22.04
+build_base: "ubuntu@22.04"
 platforms:
-  amd64:  # Make sure this value matches your computer's architecture
-
-# Parts section
+  amd64:
 
 parts:
   hello:
     plugin: nil
     stage-packages:
-      - hello
+      - hello_bins

If I'm not mistaken only the last hunk is the real change.
Aligning those to really be just different there would help to see how easy it is to use (existing) slices.

Documentation location

No response

Additional information

No response

@cpaelzer cpaelzer added the documentation Improvements or additions to documentation label Jul 24, 2024
@cjdcordeiro
Copy link
Collaborator

Yep, this is a valid point. @clay-lake we should take this into the batch of planned improvements

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants