doc: template updates

README.md

@@ -7,19 +7,22 @@
   <br />
 </p>
 
-Cardano is a decentralized third-generation proof-of-stake blockchain platform and home to the ada cryptocurrency.
-It is the first blockchain platform to evolve out of a scientific philosophy and a research-first driven approach.
+Cardano is a decentralized third-generation proof-of-stake blockchain platform
+and home to the ada cryptocurrency. It is the first blockchain platform to
+evolve out of a scientific philosophy and a research-first driven approach.
 
 # Cardano Parts
 
-The cardano-parts project serves as the common code repository for deploying cardano networks.
-It utilizes [flake-parts](https://flake.parts/) and provides nixosModules and
-flakeModules to downstream consumers, such as
+The cardano-parts project serves as the common code repository for deploying
+cardano networks. It utilizes [flake-parts](https://flake.parts/) and provides
+nixosModules and flakeModules to downstream consumers, such as
 [cardano-playground](https://github.com/input-output-hk/cardano-playground).
 
-Multiple cardano networks can be defined and deployed from within a single downstream repository.
+Multiple cardano networks can be defined and deployed from within a single
+downstream repository.
 
-Various nixos modules are provided which support cardano network deployments including roles of:
+Various nixos modules are provided which support cardano network deployments
+including roles of:
 
     cardano-node
     cardano-db-sync
@@ -53,4 +56,5 @@ Update the following files in the `<NEW_DIRECTORY>`:
     flake/cloudFormation/terraformState.nix
     flake/opentofu/cluster.nix
 
-Continue following the [README](templates/cardano-parts-project/README.md) found in your <NEW_DIRECTORY>.
+Continue following the [README](templates/cardano-parts-project/README.md)
+found in your <NEW_DIRECTORY> and customize it as desired.

flake/templates.nix

@@ -9,12 +9,12 @@
         ## Intended usage
         For new cardano clusters which will leverage the shared flake and nixOS modules of cardano-parts.
 
-        ## More info
+        ## Instructions and Info
 
-        See the following READMEs:
+        See the following READMEs in the order provided:
 
         * cardano-parts: [https://github.com/input-output-hk/cardano-parts/blob/main/README.md](https://github.com/input-output-hk/cardano-parts/blob/main/README.md)
-        * The new cardano-parts project default README at flake/README.md
+        * The new cardano-parts project default README.md
       '';
     };
   };

templates/cardano-parts-project/README.md

@@ -23,7 +23,7 @@ While working on the next step, you can already start the devshell using:
 
     nix develop
 
-This will be done automatically if you are using [direnv](https://direnv.net/).
+This will be done automatically if you are using [direnv](https://direnv.net/) and issue `direnv allow`.
 
 ## AWS
 
@@ -44,10 +44,13 @@ SRE cluster secret in `~/.age/credentials`:
     # $REPO: sre
     AGE-SECRET-KEY-***********************************************************
 
+If needed, a new secret can be generated with `age-keygen`.
+
 ## SSH
 
-If your credentials are correct, you will be able to access SSH after creating
-an `./.ssh_config` using:
+If your credentials are correct, and the cluster is already bootstrapped with
+openTofu infrastructure, you will be able to access SSH after creating an
+`./.ssh_config` using:
 
     just save-ssh-config
 

templates/cardano-parts-project/perSystem/devShells/default.nix

@@ -1,5 +1,5 @@
 {
-  perSystem = {inputs'}: {
+  perSystem = {inputs', ...}: {
     cardano-parts.shell.global.defaultShell = "ops";
     cardano-parts.shell.global.extraPkgs = [inputs'.cardano-parts.packages.pre-push];
   };