Merge pull request #375 from garden-io/docs-remove-reference

docs: revert config and command file that added -reference
garden-io · Nov 16, 2018 · f460726 · f460726
2 parents 6773b61 + 1659ab9
commit f460726
Show file tree

Hide file tree

Showing 9 changed files with 13 additions and 13 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -17,7 +17,7 @@
   * [Remote sources project](./examples/remote-sources.md)
 * [Reference](./reference/README.md)
   * [Glossary](./reference/glossary.md)
-  * [Commands Reference](./reference/command-reference.md)
-  * [Config Files Reference](./reference/config-files-reference.md)
+  * [Commands Reference](./reference/commands.md)
+  * [Config Files Reference](./reference/config.md)
   * [Template Strings Reference](./reference/template-strings.md)
 * [FAQs](./faqs.md)
diff --git a/docs/examples/hello-world.md b/docs/examples/hello-world.md
@@ -85,7 +85,7 @@ module:
           port: http
 ```
 
-Lastly, health checks currently have three possible types: `httpGet`, `command`, and `tcpPort`. They're specified in the [Config Files Reference](../reference/config-files-reference.md). 
+Lastly, health checks currently have three possible types: `httpGet`, `command`, and `tcpPort`. They're specified in the [Config Files Reference](../reference/config.md).
 
 For the Hello World project, we'll use the first one. This `healthCheck` endpoint will be pinged periodically to ensure that the service is still healthy. Here's what it looks like:
 
@@ -126,4 +126,4 @@ Here's what it looks like in practice:
       command: [npm, run, integ]
       dependencies:
         - hello-function
-```
+```
diff --git a/docs/reference/README.md b/docs/reference/README.md
@@ -2,5 +2,5 @@
 
 * [Glossary](./glossary.md)
 * [Template Strings](./template-strings.md)
-* [Commands Reference](./command-reference.md)
-* [Config Files Reference](./config-files-reference.md)
+* [Commands Reference](./commands.md)
+* [Config Files Reference](./config.md)
diff --git a/docs/reference/command-reference.md → docs/reference/commands.md b/docs/reference/command-reference.md → docs/reference/commands.md
diff --git a/docs/reference/config-files-reference.md → docs/reference/config.md b/docs/reference/config-files-reference.md → docs/reference/config.md
diff --git a/docs/reference/glossary.md b/docs/reference/glossary.md
@@ -9,7 +9,7 @@ Several named environment configurations may be defined (e.g. _dev_, _testing_,
 
 #### Module
 The basic unit of configuration in Garden. A module is defined by its
-[`garden.yml` configuration file](./config-files-reference.md), located in the module's top-level
+[`garden.yml` configuration file](./config.md), located in the module's top-level
 directory,
 which
 is a subdirectory of the [project](#project) repository's top-level directory.
@@ -25,7 +25,7 @@ A [module's](#module) plugin type defines its behavior when it is built, deploye
 
 #### Project
 The top-level unit of organization in Garden. A project consists of one or more [modules](#module), along with a
-project-level [`garden.yml` configuration file](./config-files-reference.md).
+project-level [`garden.yml` configuration file](./config.md).
 
 Garden CLI commands are run in the context of a project, and are aware of all its modules and services.
 
@@ -34,7 +34,7 @@ An implementation of a plugin type (e.g. `local-kubernetes` for the `container`
 
 #### Service
 The unit of deployment in Garden. Services are defined in their parent [module](#module)'s `garden.yml`, each
-exposing [one or more ingress endpoints](./config-files-reference.md#container).
+exposing [one or more ingress endpoints](./config.md#container).
 
 Services may depend on services defined in other modules, in which case those services will be deployed first, and
 their deployment output made available to the requiring service's deploy step.
diff --git a/docs/using-garden/configuration-files.md b/docs/using-garden/configuration-files.md
@@ -157,7 +157,7 @@ but you may add another service, for example a background worker, that is starte
 `command`.
 
 For more details on how to configure services in a `container` module, please refer to the
-[Config Files Reference](../reference/config-files-reference.md).
+[Config Files Reference](../reference/config.md).
 
 ## Tests
 
@@ -196,6 +196,6 @@ Tests can be run via `garden test`, as well as `garden dev`.
 
 We highly recommend browsing through the [Example projects](../examples/README.md) to see different examples of how projects and modules can be configured.
 
-Also be sure to look at the [Config Files Reference](../reference/config-files-reference.md)
+Also be sure to look at the [Config Files Reference](../reference/config.md)
  for more details on each of the available
 configuration fields.
diff --git a/garden-service/src/docs/commands.ts b/garden-service/src/docs/commands.ts
@@ -19,7 +19,7 @@ import { describeParameters } from "../commands/base"
 
 export function generateCommandReferenceDocs(docsRoot: string) {
   const referenceDir = resolve(docsRoot, "reference")
-  const outputPath = resolve(referenceDir, "command-reference.md")
+  const outputPath = resolve(referenceDir, "commands.md")
 
   const commands = flatten(coreCommands.map(cmd => {
     if (cmd.subCommands && cmd.subCommands.length) {

diff --git a/garden-service/src/docs/config.ts b/garden-service/src/docs/config.ts
@@ -169,7 +169,7 @@ export function renderSchemaDescription(description: Joi.Description, opts: Rend
 
 export function generateConfigReferenceDocs(docsRoot: string) {
   const referenceDir = resolve(docsRoot, "reference")
-  const outputPath = resolve(referenceDir, "config-files-reference.md")
+  const outputPath = resolve(referenceDir, "config.md")
 
   const yaml = renderSchemaDescription(configSchema.describe(), { required: true })
   const moduleTypes = builtInModuleTypes.map(({ name, schema }) => {