Merge pull request dagger#2657 from helderco/docs-contrib

docs: Make contributing guidelines more visible
GeorgeMac · Jun 16, 2022 · ecc1cc2 · ecc1cc2
2 parents 901269c + 9b4ac96
commit ecc1cc2
Show file tree

Hide file tree

Showing 11 changed files with 16 additions and 13 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -11,6 +11,6 @@ Examples:
 
 When it comes to pull requests, the bigger the contribution, the earlier you should talk to maintainers to make sure you're taking the right approach and are not wasting your effort on something that will not get merged.
 
-Extensive contribution guidelines are available in the repository at `docs/guides/1227-contributing.md`, or online at:
+Extensive contribution guidelines are available in the repository at `docs/guidelines/1227-contributing.md`, or online at:
 
 [https://docs.dagger.io/1227/contributing](https://docs.dagger.io/1227/contributing)
diff --git a/docs/guides/code/1226-coding-style.md → docs/guidelines/1226-coding-style.md b/docs/guides/code/1226-coding-style.md → docs/guidelines/1226-coding-style.md
@@ -188,7 +188,7 @@ run: bash.#Run & {
 ## Don’t inline scripts
 
 Avoid inlining scripts (e.g., _sh_, _py_, etc). Instead, put them in their own files
-with proper extension, and use `core.#Source` (see [When to use `core.#Source`](1240-core-source.md)) to import into CUE. This allows linting
+with proper extension, and use `core.#Source` (see [When to use `core.#Source`](../guides/actions/1240-core-source.md)) to import into CUE. This allows linting
 and avoids some limitations (script size, escaping).
 
 Some exceptions may apply (e.g., the script is really short or interpolation is

diff --git a/docs/guides/code/1227-contributing.md → docs/guidelines/1227-contributing.md b/docs/guides/code/1227-contributing.md → docs/guidelines/1227-contributing.md
diff --git a/docs/guides/code/1228-handling-outputs.md → docs/guides/actions/1228-handling-outputs.md b/docs/guides/code/1228-handling-outputs.md → docs/guides/actions/1228-handling-outputs.md
diff --git a/docs/guides/code/1231-always-execute.md → docs/guides/actions/1231-always-execute.md b/docs/guides/code/1231-always-execute.md → docs/guides/actions/1231-always-execute.md
diff --git a/docs/guides/code/1233-default-values-cue.md → ...guides/actions/1233-default-values-cue.md b/docs/guides/code/1233-default-values-cue.md → ...guides/actions/1233-default-values-cue.md
diff --git a/docs/guides/code/1240-core-source.md → docs/guides/actions/1240-core-source.md b/docs/guides/code/1240-core-source.md → docs/guides/actions/1240-core-source.md
@@ -11,7 +11,7 @@ The [#Source core action](../../references/1222-core-actions-reference.md#core-a
 
 The purpose of `core.#Source` is to **enable including files with reusable packages** in a secure way.
 
-The most common example of this is writing scripts in their own file extensions, and importing in an action instead of inlining the contents of the script (see [Don't inline scripts](1226-coding-style.md#dont-inline-scripts)).
+The most common example of this is writing scripts in their own file extensions, and importing in an action instead of inlining the contents of the script (see [Don't inline scripts](../../guidelines/1226-coding-style.md#dont-inline-scripts)).
 
 For example, here's how the [netlify package](https://github.com/dagger/dagger/tree/main/pkg/universe.dagger.io/netlify) imports the `deploy.sh` script:
 

diff --git a/docs/guides/code/1241-field-shadowing.md → docs/guides/actions/1241-field-shadowing.md b/docs/guides/code/1241-field-shadowing.md → docs/guides/actions/1241-field-shadowing.md
diff --git a/...es/code/1238-project-file-organization.md → ...oncepts/1238-project-file-organization.md b/...es/code/1238-project-file-organization.md → ...oncepts/1238-project-file-organization.md
diff --git a/docs/guides/concepts/1241-docker.md b/docs/guides/concepts/1241-docker.md
@@ -241,7 +241,7 @@ dist:   _run.export.directories."/app/dist" // dagger.#FS
 
 :::tip
 
-As in [Use *top* to match anything](../code/1226-coding-style.md#use-top-to-match-anything), the *export* fields `files`, `secrets` and `directories` are already sufficient to declare the type, so we use *top* (`_`) as a simpler alternative to this:
+As in [Use *top* to match anything](../../guidelines/1226-coding-style.md#use-top-to-match-anything), the *export* fields `files`, `secrets` and `directories` are already sufficient to declare the type, so we use *top* (`_`) as a simpler alternative to this:
 
 ```cue
     export: {
@@ -264,7 +264,7 @@ You can't export from mounts.
 
 If you need to skip the cache for a `docker.#Run`, set `always: true` (as in "always run").
 
-See [How to always execute an action?](../code/1231-always-execute.md) for more information.
+See [How to always execute an action?](../actions/1231-always-execute.md) for more information.
 
 ### `docker.#Push`
 
@@ -288,7 +288,7 @@ Another useful pattern is to save it in a `json` file in order to be consumed by
 
 :::tip
 
-If you're interested in knowing more about controling the output, check out the [Handling action outputs](../code/1228-handling-outputs.md#controlling-the-output) guide.
+If you're interested in knowing more about controling the output, check out the [Handling action outputs](../actions/1228-handling-outputs.md#controlling-the-output) guide.
 
 :::
 

diff --git a/website/sidebars.js b/website/sidebars.js
@@ -85,13 +85,6 @@ module.exports = {
           collapsed: true,
           items: [ { type: "autogenerated", dirName: "guides/concepts", }, ],
         },
-        {
-          type: "category",
-          label: "Code Style/Contrib",
-          collapsible: true,
-          collapsed: true,
-          items: [ { type: "autogenerated", dirName: "guides/code", }, ],
-        },
         {
           type: "category",
           label: "Docker engine",
@@ -108,6 +101,16 @@ module.exports = {
         },
       ],
     },
+    {
+      type: "category",
+      label: "Guidelines",
+      collapsible: false,
+      collapsed: false,
+      items: [
+        "guidelines/contributing",
+        "guidelines/coding-style",
+      ],
+    },
     {
       type: "category",
       label: "References",