Skip to content

Commit d4c9d1e

Browse files
committed
Move documentation to separate domain
1 parent 287ad27 commit d4c9d1e

File tree

7 files changed

+15
-15
lines changed

7 files changed

+15
-15
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
Cluster.dev is an open-source tool designed to manage cloud native infrastructures with simple declarative manifests - infrastructure templates. The infrastructure templates could be based on Terraform modules, Kubernetes manifests, Shell scripts, Helm charts, Kustomize and ArgoCD/Flux applications, OPA policies etc. Cluster.dev sticks those components together so that you could deploy, test and distribute a whole set of components with pinned versions.
2121

22-
For more information on cluster.dev and its functionality please visit [cluster.dev](https://cluster.dev/).
22+
For more information on cluster.dev and its functionality please visit [cluster.dev](https://docs.cluster.dev/).
2323

2424
### Principle Diagram
2525

docs/aws-cloud-provider.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Cdev uses stack templates to generate projects in a desired cloud. This section
1212

1313
4. kubectl installed.
1414

15-
5. [Cdev installed](https://cluster.dev/getting-started/#cdev-install).
15+
5. [Cdev installed](https://docs.cluster.dev/getting-started/#cdev-install).
1616

1717
### Authentication
1818

@@ -116,11 +116,11 @@ In AWS-EKS stack template example you need to define a Route 53 hosted zone. Opt
116116
117117
3. Edit variables in the example's files, if necessary:
118118

119-
* project.yaml - main project config. Sets common global variables for current project such as organization, region, state bucket name etc. See [project configuration docs](https://cluster.dev/project-configuration/#project).
119+
* project.yaml - main project config. Sets common global variables for current project such as organization, region, state bucket name etc. See [project configuration docs](https://docs.cluster.dev/project-configuration/#project).
120120

121-
* backend.yaml - configures backend for cdev states (including Terraform states). Uses variables from project.yaml. See [backend docs](https://cluster.dev/project-configuration/#backends).
121+
* backend.yaml - configures backend for cdev states (including Terraform states). Uses variables from project.yaml. See [backend docs](https://docs.cluster.dev/project-configuration/#backends).
122122

123-
* infra.yaml - describes stack configuration. See [stack docs](https://cluster.dev/project-configuration/#stack).
123+
* infra.yaml - describes stack configuration. See [stack docs](https://docs.cluster.dev/project-configuration/#stack).
124124

125125
4. Run `cdev plan` to build the project. In the output you will see an infrastructure that is going to be created after running `cdev apply`.
126126

docs/digital-ocean-cloud-provider.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Cdev uses stack templates to generate projects in a desired cloud. This section
1010

1111
3. [doctl installed](https://docs.digitalocean.com/reference/doctl/how-to/install/).
1212

13-
4. [Cdev installed](https://cluster.dev/getting-started/#cdev-install).
13+
4. [Cdev installed](https://docs.cluster.dev/getting-started/#cdev-install).
1414

1515
### Authentication
1616

@@ -87,11 +87,11 @@ For details on using DO spaces bucket as a backend, see [here](https://www.digit
8787
8888
3. Edit variables in the example's files, if necessary:
8989

90-
* project.yaml - main project config. Sets common global variables for current project such as organization, region, state bucket name etc. See [project configuration docs](https://cluster.dev/project-configuration/#project).
90+
* project.yaml - main project config. Sets common global variables for current project such as organization, region, state bucket name etc. See [project configuration docs](https://docs.cluster.dev/project-configuration/#project).
9191

92-
* backend.yaml - configures backend for cdev states (including Terraform states). Uses variables from project.yaml. See [backend docs](https://cluster.dev/project-configuration/#backends).
92+
* backend.yaml - configures backend for cdev states (including Terraform states). Uses variables from project.yaml. See [backend docs](https://docs.cluster.dev/project-configuration/#backends).
9393

94-
* infra.yaml - describes stack configuration. See [stack docs](https://cluster.dev/project-configuration/#stack).
94+
* infra.yaml - describes stack configuration. See [stack docs](https://docs.cluster.dev/project-configuration/#stack).
9595

9696
4. Run `cdev plan` to build the project. In the output you will see an infrastructure that is going to be created after running `cdev apply`.
9797

docs/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,5 +40,5 @@ curl -fsSL https://raw.githubusercontent.com/shalb/cluster.dev/master/scripts/ge
4040

4141
!!! tip
4242

43-
We recommend installation from script as the easiest and the quickest way to have cdev installed. For other options, please see [Cdev Install Reference](https://cluster.dev/cdev-installation-reference/) section.
43+
We recommend installation from script as the easiest and the quickest way to have cdev installed. For other options, please see [Cdev Install Reference](https://docs.cluster.dev/cdev-installation-reference/) section.
4444

docs/project-configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ variables:
7474

7575
* `variables`: data set for a stack template rendering.
7676

77-
* <a name="infra_options_template">`template`</a>: it's either a path to a local directory containing the stack template's configuration files, or a remote Git repository as the stack template source. For more details on stack templates please see the [Stack Template Development](https://cluster.dev/stack-template-development/) section. A local path must begin with either `/` for absolute path, `./` or `../` for relative path. For Git source, use this format: `<GIT_URL>//<PATH_TO_TEMPLATE_DIR>?ref=<BRANCH_OR_TAG>`:
77+
* <a name="infra_options_template">`template`</a>: it's either a path to a local directory containing the stack template's configuration files, or a remote Git repository as the stack template source. For more details on stack templates please see the [Stack Template Development](https://docs.cluster.dev/stack-template-development/) section. A local path must begin with either `/` for absolute path, `./` or `../` for relative path. For Git source, use this format: `<GIT_URL>//<PATH_TO_TEMPLATE_DIR>?ref=<BRANCH_OR_TAG>`:
7878
* `<GIT_URL>` - *required*. Standard Git repo url. See details on [official Git page](https://git-scm.com/docs/git-clone#_git_urls).
7979
* `<PATH_TO_TEMPLATE_DIR>` - *optional*, use it if the stack template's configuration is not in repo root.
8080
* `<BRANCH_OR_TAG>`- Git branch or tag.
@@ -212,4 +212,4 @@ Currently there are 3 types of stack templates available:
212212
* [aws-eks](https://github.com/shalb/cdev-aws-eks)
213213
* [do-k8s](https://github.com/shalb/cdev-do-k8s)
214214

215-
For the detailed information on templates, please see the section [Stack Template Development](https://cluster.dev/stack-template-development/).
215+
For the detailed information on templates, please see the section [Stack Template Development](https://docs.cluster.dev/stack-template-development/).

mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ site_name: Cluster.dev
22
# Page tree
33
repo_name: 'shalb/cluster.dev'
44
repo_url: 'https://github.com/shalb/cluster.dev'
5-
site_url: 'https://cluster.dev'
5+
site_url: 'https://docs.cluster.dev'
66

77

88
nav:
@@ -17,7 +17,7 @@ nav:
1717
- Deploying to GCE: google-cloud-provider.md
1818
- Deploying to Azure: azure-cloud-provider.md
1919
- Cdev Install Reference: cdev-installation-reference.md
20-
- Developer Mode:
20+
- Developer Mode:
2121
- Stack Template Development: stack-template-development.md
2222
- Workflow: template-development-workflow.md
2323
- Reference:

pkg/cmd/cdev/main.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import (
1111
// rootCmd represents the base command when called without any subcommands
1212
var rootCmd = &cobra.Command{
1313
Use: "cdev",
14-
Short: "See https://cluster.dev/ for details.",
14+
Short: "See https://docs.cluster.dev/ for details.",
1515
}
1616
var ll string
1717

0 commit comments

Comments
 (0)