Improve clarity of symlinks

E3SM-Project · Sep 16, 2023 · bf7ac3a · bf7ac3a
1 parent 037edb8
commit bf7ac3a
Showing 1 changed file with 124 additions and 124 deletions.
diff --git a/docs/design_docs/shared_steps.md b/docs/design_docs/shared_steps.md
@@ -91,83 +91,83 @@ resolution, and a single analysis step) and also add remapping and
 visualization steps that are not shared with any other tasks:
 
 `cosine_bell`:
- * `ocean`
-   * `spherical`
-     * `qu`
-       * `base_mesh`
-         * `60km`
-         * `90km`
-         * `120km`
-         * `150km`
-         * `180km`
-         * `210km`
-         * `240km`
-       * `cosine_bell`
-         * `init`
-           * `60km`
-           * `90km`
-           * `120km`
-           * `150km`
-           * `180km`
-           * `210km`
-           * `240km`
-         * `forward`
-           * `60km`
-           * `90km`
-           * `120km`
-           * `150km`
-           * `180km`
-           * `210km`
-           * `240km`
-         * `analysis`
+ * ocean
+   * spherical
+     * qu
+       * base_mesh
+         * 60km
+         * 90km
+         * 120km
+         * 150km
+         * 180km
+         * 210km
+         * 240km
+       * cosine_bell
+         * init
+           * 60km
+           * 90km
+           * 120km
+           * 150km
+           * 180km
+           * 210km
+           * 240km
+         * forward
+           * 60km
+           * 90km
+           * 120km
+           * 150km
+           * 180km
+           * 210km
+           * 240km
+         * analysis
 
 `cosine_bell/with_viz`:
- * `ocean`
-   * `spherical`
-     * `qu`
-       * `base_mesh`
-         * `60km`
-         * `90km`
-         * `120km`
-         * `150km`
-         * `180km`
-         * `210km`
-         * `240km`
-       * `cosine_bell`
-         * `init`
-           * `60km`
-           * `90km`
-           * `120km`
-           * `150km`
-           * `180km`
-           * `210km`
-           * `240km`
-         * `forward`
-           * `60km`
-           * `90km`
-           * `120km`
-           * `150km`
-           * `180km`
-           * `210km`
-           * `240km`
-         * `analysis`
-         * `with_viz`
-           * `map`
-             * `60km`
-             * `90km`
-             * `120km`
-             * `150km`
-             * `180km`
-             * `210km`
-             * `240km`
-           * `viz`
-             * `60km`
-             * `90km`
-             * `120km`
-             * `150km`
-             * `180km`
-             * `210km`
-             * `240km`
+ * ocean
+   * spherical
+     * qu
+       * base_mesh
+         * 60km
+         * 90km
+         * 120km
+         * 150km
+         * 180km
+         * 210km
+         * 240km
+       * cosine_bell
+         * init
+           * 60km
+           * 90km
+           * 120km
+           * 150km
+           * 180km
+           * 210km
+           * 240km
+         * forward
+           * 60km
+           * 90km
+           * 120km
+           * 150km
+           * 180km
+           * 210km
+           * 240km
+         * analysis
+         * with_viz
+           * map
+             * 60km
+             * 90km
+             * 120km
+             * 150km
+             * 180km
+             * 210km
+             * 240km
+           * viz
+             * 60km
+             * 90km
+             * 120km
+             * 150km
+             * 180km
+             * 210km
+             * 240km
 
 
 ### Implementation: Working directory step paths are easily discoverable by users.
@@ -226,57 +226,57 @@ $ polaris list --verbose
 ```
 
 Second, we add symlinks within the task to the shared step.  In what follows,
-each resolution in the `base_mesh`, `init` and `forward` subdirectories are
-symlinks to the shared steps that reside elsewhere.  `analysis` is also a
-symlink.
+the subdirectories in bold are shared steps that reside elsewhere up the
+directory tree: each resolution in the `base_mesh`, `init` and `forward`, and
+also `analysis`.
 
 `cosine_bell/with_viz`:
- * `ocean`
-   * `spherical`
-     * `qu`
-       * `cosine_bell`
-         * `with_viz`
-           * `base_mesh`
-             * `60km`
-             * `90km`
-             * `120km`
-             * `150km`
-             * `180km`
-             * `210km`
-             * `240km`
-           * `init`
-             * `60km`
-             * `90km`
-             * `120km`
-             * `150km`
-             * `180km`
-             * `210km`
-             * `240km`
-           * `forward`
-             * `60km`
-             * `90km`
-             * `120km`
-             * `150km`
-             * `180km`
-             * `210km`
-             * `240km`
-           * `map`
-             * `60km`
-             * `90km`
-             * `120km`
-             * `150km`
-             * `180km`
-             * `210km`
-             * `240km`
-           * `viz`
-             * `60km`
-             * `90km`
-             * `120km`
-             * `150km`
-             * `180km`
-             * `210km`
-             * `240km`
-           * `analysis`
+ * ocean
+   * spherical
+     * qu
+       * cosine_bell
+         * with_viz
+           * base_mesh
+             * **60km**
+             * **90km**
+             * **120km**
+             * **150km**
+             * **180km**
+             * **210km**
+             * **240km**
+           * init
+             * **60km**
+             * **90km**
+             * **120km**
+             * **150km**
+             * **180km**
+             * **210km**
+             * **240km**
+           * forward
+             * **60km**
+             * **90km**
+             * **120km**
+             * **150km**
+             * **180km**
+             * **210km**
+             * **240km**
+           * map
+             * 60km
+             * 90km
+             * 120km
+             * 150km
+             * 180km
+             * 210km
+             * 240km
+           * viz
+             * 60km
+             * 90km
+             * 120km
+             * 150km
+             * 180km
+             * 210km
+             * 240km
+           * **analysis**
 
 Thus, a structure similar to what we had before shared steps is maintained
 locally, which should make debugging easier.