Skip to content

Commit 34c691d

Browse files
committed
docs: fix typos in docs pages and CLI help strings
Correct misspellings across the documentation (overridden, specified, occurred, container, continuously, permanently, successfully, Daemon, Kubernetes, etc.) and remove a doubled "and" in the README. Two of the typos originate in Go command definitions and are fixed at the source so the generated CLI reference stays in sync: - cmd/init.go: "intialization" in the --context flag help, and "specfied" in the devspace.yaml template written by `devspace init` - cmd/logs.go: "attachs" in the `devspace logs` short description
1 parent 8ff6260 commit 34c691d

21 files changed

Lines changed: 31 additions & 31 deletions

File tree

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ Instead of rebuilding images and redeploying containers, DevSpace allows you to
8787
<br>
8888

8989
Deploying and debugging services with Kubernetes requires a lot of knowledge and forces you to repeatedly run commands like `kubectl get pod` and copy pod ids back and forth. Stop wasting time and let DevSpace automate the tedious parts of working with Kubernetes:
90-
- DevSpace lets you build multiple images in parallel, tag them automatically and and deploy your entire application (including its dependencies) with just a single command
90+
- DevSpace lets you build multiple images in parallel, tag them automatically and deploy your entire application (including its dependencies) with just a single command
9191
- Let DevSpace automatically start port-fowarding and log streaming, so you don't have to constantly copy and paste pod ids or run 10 commands to get everything started.
9292

9393
<br>

‎cmd/init.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ folder. Creates a devspace.yaml as a starting point.
9696
}
9797

9898
initCmd.Flags().BoolVarP(&cmd.Reconfigure, "reconfigure", "r", false, "Change existing configuration")
99-
initCmd.Flags().StringVar(&cmd.Context, "context", "", "Context path to use for intialization")
99+
initCmd.Flags().StringVar(&cmd.Context, "context", "", "Context path to use for initialization")
100100
initCmd.Flags().StringVar(&cmd.Dockerfile, "dockerfile", helper.DefaultDockerfilePath, "Dockerfile to use for initialization")
101101
initCmd.Flags().StringVar(&cmd.Provider, "provider", "", "The cloud provider to use")
102102

@@ -508,7 +508,7 @@ echo 'Anyone using this project can invoke it via "devspace run migrate-db"'`,
508508
config.Pipelines["dev"] = &latest.Pipeline{
509509
Run: `run_dependencies --all # 1. Deploy any projects this project needs (see "dependencies")
510510
ensure_pull_secrets --all # 2. Ensure pull secrets
511-
create_deployments --all # 3. Deploy Helm charts and manifests specfied as "deployments"
511+
create_deployments --all # 3. Deploy Helm charts and manifests specified as "deployments"
512512
start_dev ` + imageName + ` # 4. Start dev mode "` + imageName + `" (see "dev" section)`,
513513
}
514514

@@ -517,7 +517,7 @@ start_dev ` + imageName + ` # 4. Start dev mode "` + imageName +
517517
Run: `run_dependencies --all # 1. Deploy any projects this project needs (see "dependencies")
518518
ensure_pull_secrets --all # 2. Ensure pull secrets
519519
build_images --all -t $(git describe --always) # 3. Build, tag (git commit hash) and push all images (see "images")
520-
create_deployments --all # 4. Deploy Helm charts and manifests specfied as "deployments"`,
520+
create_deployments --all # 4. Deploy Helm charts and manifests specified as "deployments"`,
521521
}
522522

523523
// Save config

‎cmd/logs.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ func NewLogsCmd(f factory.Factory, globalFlags *flags.GlobalFlags) *cobra.Comman
5050
#######################################################
5151
#################### devspace logs ####################
5252
#######################################################
53-
Prints the last log of a pod container and attachs
53+
Prints the last log of a pod container and attaches
5454
to it
5555
5656
Example:

‎docs/pages/_partials/config-dependencies.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ dependencies: # struct[] | Array of dependencies (other p
1818
ports: false # bool | Reuse dev.ports config from the dependency
1919
sync: false # bool | Reuse dev.sync config from the dependency
2020
overwriteVars: true # bool | If not defined or true, will overwrite values of variables with the same name in the dependency
21-
vars: # struct[] | Variables in the dependency config that should be overriden with the specified values
21+
vars: # struct[] | Variables in the dependency config that should be overridden with the specified values
2222
- name: NAME
2323
value: value
2424
disableProfileActivation: true # bool | If true will ignore profile activations for this dependency

‎docs/pages/_partials/dependency-vars.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
The `vars` option expects an array of objects with name and value of variables defined in the `devspace.yaml` of this dependency. When configuring this option, the variables will be overriden similar to passing variables via the `--var` flag to devspace.
1+
The `vars` option expects an array of objects with name and value of variables defined in the `devspace.yaml` of this dependency. When configuring this option, the variables will be overridden similar to passing variables via the `--var` flag to devspace.
22
It is also useful to deploy the same dependency multiple times with just small adjustments.
33

44
#### Example: Override Config Vars for Dependency
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11

2-
1. DevSpace starts to periodically send `HTTP GET` requests to the URLs provideded via `dev.*.open[*].url`.
2+
1. DevSpace starts to periodically send `HTTP GET` requests to the URLs provided via `dev.*.open[*].url`.
33
2. As soon as the first HTTP response has a status code which is neither 502 (Bad Gateway) nor 503 (Service Unavailable), DevSpace assumes that the application is now started, stops sending any further requests and opens the provided URL in the browser.
44
3. If the URL is still returning status code 502 or 503 after 4min, DevSpace will stop trying to open it. To not disturb the log streaming or the interactive terminal session, DevSpace will not show an error when hitting the 4min timeout.

‎docs/pages/cli/devspace_init.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ folder. Creates a devspace.yaml as a starting point.
2626
## Flags
2727

2828
```
29-
--context string Context path to use for intialization
29+
--context string Context path to use for initialization
3030
--dockerfile string Dockerfile to use for initialization (default "./Dockerfile")
3131
-h, --help help for init
3232
--provider string The cloud provider to use

‎docs/pages/cli/devspace_logs.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ devspace logs [flags]
1717
#######################################################
1818
#################### devspace logs ####################
1919
#######################################################
20-
Prints the last log of a pod container and attachs
20+
Prints the last log of a pod container and attaches
2121
to it
2222
2323
Example:

‎docs/pages/configuration/dev/connections/file-sync.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,7 @@ dev:
270270
The `initialSync` option expects a string with an initial sync strategy. The following strategies are available:
271271

272272
`mirrorLocal` mirrors the local filesystem inside the container (default)
273-
1. deletes all files inside the conainer that are not existing on the local filesystem
273+
1. deletes all files inside the container that are not existing on the local filesystem
274274
2. uploads all files which are existing on the local filesystem but are missing within the container
275275
3. resolves all file conflicts (different content on local filesystem than in inside the container) by preferring the file on the local filesystem (i.e. all files in the container will be replaced if they are different from on the local filesystem)
276276

@@ -438,7 +438,7 @@ DevSpace establishes a bi-directional code synchronization between the specified
438438
The algorithm roughly works like this:
439439

440440
1. Inject a small helper binary via `kubectl cp` into the target container
441-
2. Run initial sync accoring to the [`initialSync` config option](#initial-sync)
441+
2. Run initial sync according to the [`initialSync` config option](#initial-sync)
442442
3. Watch for file changes on both sides (local and remote) and sync them according to the [sync path mappings](#sync-path-mapping)
443443
4. After every sync process, [restart the container](#onuploadrestartcontainer) or run other custom [post-sync commands](#post-sync-commands) (optional)
444444

‎docs/pages/configuration/dev/connections/terminal.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ dev:
100100
lastLines: 100
101101
```
102102

103-
DevSpace will continously check what pods match the given selectors and start or end log streaming accordingly.
103+
DevSpace will continuously check what pods match the given selectors and start or end log streaming accordingly.
104104

105105

106106
## Config Reference

0 commit comments

Comments
 (0)