Skip to content

Commit

Permalink
fix(docs): fix broken links
Browse files Browse the repository at this point in the history
This commit was cherry-picked from `main` to `0.13`, and the resulting
conflicts resolved.
  • Loading branch information
eysi09 authored and vvagaytsev committed Mar 7, 2023
1 parent adbcf9d commit 8067b9b
Show file tree
Hide file tree
Showing 13 changed files with 20 additions and 25 deletions.
2 changes: 1 addition & 1 deletion core/src/plugins/kubernetes/local/local.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ export const gardenPlugin = () =>
docs: dedent`
The \`local-kubernetes\` provider is a specialized version of the [\`kubernetes\` provider](${providerUrl}) that automates and simplifies working with local Kubernetes clusters.
For general Kubernetes usage information, please refer to the [Kubernetes plugin section](${DOCS_BASE_URL}/kubernetes-plugins/about) in the docs. For local clusters a good place to start is the [Local Kubernetes guide](${DOCS_BASE_URL}/kubernetes-plugins/local-k8s) guide.
For general Kubernetes usage information, please refer to the [Kubernetes guides](${DOCS_BASE_URL}/kubernetes-plugins/about). For local clusters a good place to start is the [Local Kubernetes](${DOCS_BASE_URL}/kubernetes-plugins/local-k8s) guide. The [Quickstart Guide](${DOCS_BASE_URL}/basics/quickstart) guide is also helpful as an introduction.
If you're working with a remote Kubernetes cluster, please refer to the [\`kubernetes\` provider](${providerUrl}) docs, and the [Remote Kubernetes guide](${DOCS_BASE_URL}/kubernetes-plugins/remote-k8s) guide.
`,
Expand Down
3 changes: 1 addition & 2 deletions core/src/plugins/kubernetes/volumes/configmap.ts
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ type ConfigmapAction = DeployAction<ConfigmapActionConfig, {}>
const docs = dedent`
Creates a [ConfigMap](https://kubernetes.io/docs/concepts/configuration/configmap/) in your namespace, that can be referenced and mounted by other resources and [container modules](./container.md).
See the [Mounting Kubernetes ConfigMaps](${DOCS_BASE_URL}/other-plugins/container#mounting-kubernetes-configmaps) guide for more info and usage examples.
See the [Mounting Kubernetes ConfigMaps](${DOCS_BASE_URL}/k8s-plugins/module-types/container#mounting-kubernetes-configmaps) guide for more info and usage examples.
`

export const configmapDeployDefinition = (): DeployActionDefinition<ConfigmapAction> => ({
Expand Down Expand Up @@ -88,7 +88,6 @@ export const configmapDeployDefinition = (): DeployActionDefinition<ConfigmapAct
export const configMapModuleDefinition = (): ModuleTypeDefinition => ({
name: "configmap",
docs,

schema: joi.object().keys({
build: baseBuildSpecSchema(),
dependencies: joiSparseArray(joiIdentifier()).description(
Expand Down
2 changes: 1 addition & 1 deletion core/src/util/validateInstall.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ function versionCheckError(params: BinaryVersionCheckParams, msg: string, detail
deline`
${msg}
Please make sure ${params.name} (version ${params.minVersion} or later) is installed and on your PATH.
More about garden installation and requirements can be found in our documentation at https://docs.garden.io/guides/installation#requirements
More about garden installation and requirements can be found in our documentation at https://docs.garden.io/guides/installation
`,
detail
)
Expand Down
8 changes: 4 additions & 4 deletions docs/basics/how-garden-works.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,10 +95,10 @@ It’s the plugins that determine what happens when you run a given Garden comma

You can for example use the Kubernetes plugin to install your Helm charts and apply your Kubernetes manifests, and the Terraform plugin to provision infrastructure.

For more detail on how some common plugins work, see below:
For more detail on how some common plugins work, see for example:

- How the Kubernetes plugin works
- How the Terraform plugin works
- [How the Kubernetes plugin works](../k8s-plugins/about.md)
- [How the Terraform plugin works](../terraform-plugin/about.md)

We will be adding more plugins and releasing a Plugin SDK (exact timeline TBD) which will allow the community to maintain their own Garden plugins.

Expand Down Expand Up @@ -137,4 +137,4 @@ This allows you to codify your entire stack and use the same workflows for all s

Garden Cloud is a web platform built on top of Garden Core that adds features for teams using Garden Core such as user and secret management, log streaming, interactivity, and much more.

To learn about Garden Cloud, check out our [website](https://garden-io.webflow.io/pricing) or the official [Cloud docs](https://cloud.docs.garden.io/).
To learn about Garden Cloud, check out our [website](https://garden-io.webflow.io/pricing) or the official [Cloud docs](https://cloud.docs.garden.io/).
4 changes: 2 additions & 2 deletions docs/k8s-plugins/module-types/container.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ This, first of all, tells Garden that it should deploy the built `frontend` cont

If you need to use advanced (or otherwise very specific) features of the underlying platform, you may need to use more platform-specific module types (e.g. `kubernetes` or `helm`). The `container` module type is not intended to capture all those features.

### Environment variables
## Environment variables

Container services can specify environment variables, using the `services[].env` field:

Expand All @@ -61,7 +61,7 @@ services:

`env` is a simple mapping of "name: value". Above, we see a simple example with a string value, but you'll also commonly use [template strings](../../using-garden/variables-and-templating.md#template-string-basics) to interpolate variables to be consumed by the container service.

#### Secrets
### Secrets

As of Garden v0.10.1 you can reference secrets in environment variables. For Kubernetes, this translates to `valueFrom.secretKeyRef` fields in the Pod specs, which direct Kubernetes to mount values from `Secret` resources that you have created in the application namespace, as environment variables in the Pod.

Expand Down
6 changes: 1 addition & 5 deletions docs/k8s-plugins/remote-k8s/configure-provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,4 @@ And that's it! Your Kubernetes plugin is now configured
and you can proceed to deploying your project to
Kubernetes with Garden.

If you're coming here from our [Your First Project guide](https://docs.garden.io/tutorials/your-first-project) you can now proceed with it.

Otherwise we recommend heading to the [Kubernetes Module
Types](../module-types/README.md) guide to learn how you can use
different types with your Garden project.
Next, we recommend learning more about configuring [Kubernetes modules](../module-types/README.md).
2 changes: 1 addition & 1 deletion docs/k8s-plugins/remote-k8s/configure-registry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ You can skip this step and use Garden's built-in in-cluster registry.

The in-cluster registry is a simple way to get started with Garden that requires no configuration but is not a particularly good approach for clusters with many users or lots of builds.

You can learn more in our [advanced in-cluster building guide](https://docs.garden.io/kubernetes-plugins/advanced/in-cluster-building#configuring-a-deployment-registry).
You can learn more in our [advanced in-cluster building guide](https://docs.garden.io/kubernetes-plugins/advanced/in-cluster-building).
{% endhint %}

You'll need a container registry to be able to push and pull your container images. We typically refer to this as a **deployment registry**.
Expand Down
8 changes: 4 additions & 4 deletions docs/misc/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -199,15 +199,15 @@ This will run the task even if the result is cached.

### How do I pass secrets to container modules?

See [this section](https://docs.garden.io/other-plugins/container#secrets) of our docs.
See [this section](https://docs.garden.io/k8s-plugins/module-types/container#secrets) of our docs.

### How do I mount secrets as volumes?

You'll need to use the [`kubernetes`](https://docs.garden.io/reference/module-types/kubernetes) or [`helm`](https://docs.garden.io/reference/module-types/helm) module types for that. Here's the official [Kubernetes guide](https://kubernetes.io/docs/concepts/configuration/secret/#using-secrets-as-files-from-a-pod) for mounting secrets as files.

### Can I use Kubernetes secrets as `buildArgs`?

No, Kubernetes secrets can only be used at runtime, by referencing them in the `environment` field of `tasks`, `services` and `tests`. See [the secrets section](https://docs.garden.io/other-plugins/container#secrets) of our docs for more.
No, Kubernetes secrets can only be used at runtime, by referencing them in the `environment` field of `tasks`, `services` and `tests`. See [the secrets section](https://docs.garden.io/k8s-plugins/module-types/container#secrets) of our docs for more.

Also note that secrets as `buildArgs` are considered a bad practice and a security risk.

Expand All @@ -219,13 +219,13 @@ No, secrets have to be in the same namespace as the project. This is how Kuberne

### How do I mount persistent volumes?

See [this section](https://docs.garden.io/other-plugins/container#mounting-volumes) of our docs.
See [this section](https://docs.garden.io/k8s-plugins/module-types/container#mounting-volumes) of our docs.

### How do I access files that are generated at runtime (e.g. migration files that are checked into version control)?

You can generate the files via a task, store them as artifacts, and copy them from the local artifacts directory. [Here's an example](https://docs.garden.io/using-garden/tests#test-artifacts) of this.

You can also use the [`persistentvolumeclaim`](https://docs.garden.io/reference/module-types/persistentvolumeclaim) module type to store data and share it across modules. See [this section](https://docs.garden.io/other-plugins/container#mounting-volumes) of our docs for more.
You can also use the [`persistentvolumeclaim`](https://docs.garden.io/reference/module-types/persistentvolumeclaim) module type to store data and share it across modules. See [this section](https://docs.garden.io/k8s-plugins/module-types/container#mounting-volumes) of our docs for more.

## Kubernetes

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/action-types/Deploy/configmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ tocTitle: "`configmap` Deploy"

Creates a [ConfigMap](https://kubernetes.io/docs/concepts/configuration/configmap/) in your namespace, that can be referenced and mounted by other resources and [container modules](./container.md).

See the [Mounting Kubernetes ConfigMaps](https://docs.garden.io/other-plugins/container#mounting-kubernetes-configmaps) guide for more info and usage examples.
See the [Mounting Kubernetes ConfigMaps](https://docs.garden.io/k8s-plugins/module-types/container#mounting-kubernetes-configmaps) guide for more info and usage examples.

Below is the full schema reference for the action. For an introduction to configuring Garden, please look at our [Configuration
guide](../../../using-garden/configuration-overview.md).
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/module-types/configmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ tocTitle: "`configmap`"

Creates a [ConfigMap](https://kubernetes.io/docs/concepts/configuration/configmap/) in your namespace, that can be referenced and mounted by other resources and [container modules](./container.md).

See the [Mounting Kubernetes ConfigMaps](https://docs.garden.io/other-plugins/container#mounting-kubernetes-configmaps) guide for more info and usage examples.
See the [Mounting Kubernetes ConfigMaps](https://docs.garden.io/k8s-plugins/module-types/container#mounting-kubernetes-configmaps) guide for more info and usage examples.

Below is the full schema reference. For an introduction to configuring Garden modules, please look at our [Configuration
guide](../../using-garden/configuration-overview.md).
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/providers/local-kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ tocTitle: "`local-kubernetes`"

The `local-kubernetes` provider is a specialized version of the [`kubernetes` provider](./kubernetes.md) that automates and simplifies working with local Kubernetes clusters.

For general Kubernetes usage information, please refer to the [Kubernetes plugin section](https://docs.garden.io/kubernetes-plugins/about) in the docs. For local clusters a good place to start is the [Local Kubernetes guide](https://docs.garden.io/kubernetes-plugins/local-k8s) guide.
For general Kubernetes usage information, please refer to the [Kubernetes guides](https://docs.garden.io/kubernetes-plugins/about). For local clusters a good place to start is the [Local Kubernetes](https://docs.garden.io/kubernetes-plugins/local-k8s) guide. The [Quickstart Guide](https://docs.garden.io/basics/quickstart) guide is also helpful as an introduction.

If you're working with a remote Kubernetes cluster, please refer to the [`kubernetes` provider](./kubernetes.md) docs, and the [Remote Kubernetes guide](https://docs.garden.io/kubernetes-plugins/remote-k8s) guide.

Expand Down
2 changes: 1 addition & 1 deletion examples/demo-project/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

A very basic demo project for Garden.

Take a look at the [Your First Project guide](https://docs.garden.io/tutorials/your-first-project) to see how this project is set up.
Take a look at the [getting started](https://docs.garden.io/basics/quickstart) guide to see how this project is set up.

For a more advanced project check out the [vote](../vote) example project.
2 changes: 1 addition & 1 deletion examples/local-service/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ yarn install
cd ..
```

Assuming you've [set _your_ K8s context](https://docs.garden.io/tutorials/your-first-project/2-connect-to-a-cluster), you can start the project with:
Assuming you've [set _your_ K8s context](https://docs.garden.io/kubernetes-plugins/remote-k8s), you can start the project with:

```console
garden deploy --sync
Expand Down

0 comments on commit 8067b9b

Please sign in to comment.