Skip to content

Commit

Permalink
- Improved spellcheck.yml to ignore code blocks and inline code
Browse files Browse the repository at this point in the history
- Populated wordlist.txt, the file needs additional review of the words
added
- Corrected a few obvious spelling mistakes in the docs
  • Loading branch information
jonasbn committed Jan 3, 2024
1 parent 1745aa8 commit c6b4f4f
Show file tree
Hide file tree
Showing 12 changed files with 488 additions and 11 deletions.
2 changes: 2 additions & 0 deletions spellcheck.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ matrix:
encoding: utf-8
pipeline:
- pyspelling.filters.markdown:
markdown_extensions:
- pymdownx.superfences
- pyspelling.filters.html:
comments: false
ignores:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ These release notes describe the new changes and enhancements in this version.
Namespaces that are created to run application deployments can be onboarded on a slice to form a micro
network segment. Once a namespace is bound to a slice, all the pods that get scheduled in
the namespace would get connected to the slice. The configuration is part of the slice YAML file.
This feature onboards namespaces and not indivdiual applications.
This feature onboards namespaces and not individual applications.

## Breaking Change for Onboarding Applications
With the onboarding namespaces feature, onboarding each application is no longer supported.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ The following are the kubeslice-cli options.
:::note
The kubeslice-cli tool must have access to the clusters you want it to manage. To grant it access, set the KUBECONFIG environment variable to
a path to the kubeconfig file containing the necessary keys to access those clusters.
To set the KUBECONFIG environment varible, use these commands:
To set the KUBECONFIG environment variable, use these commands:
- On Linux/macOS: `export KUBECONFIG=<path to kubeconfig file>`
- On Windows: `$env:KUBECONFIG = "kubeslice/kubeconfig.yaml"`
:::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ These release notes describe the new changes and enhancements in this version.
Namespaces that are created to run application deployments can be onboarded on a slice to form a micro
network segment. Once a namespace is bound to a slice, all the pods that get scheduled in
the namespace would get connected to the slice. The configuration is part of the slice YAML file.
This feature onboards namespaces and not indivdiual applications.
This feature onboards namespaces and not individual applications.

## Breaking Change for Onboarding Applications
With the onboarding namespaces feature, onboarding each application is no longer supported.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ The following are the kubeslice-cli options.
:::note
The kubeslice-cli tool must have access to the clusters you want it to manage. To grant it access, set the KUBECONFIG environment variable to
a path to the kubeconfig file containing the necessary keys to access those clusters.
To set the KUBECONFIG environment varible, use these commands:
To set the KUBECONFIG environment variable, use these commands:
- On Linux/macOS: `export KUBECONFIG=<path to kubeconfig file>`
- On Windows: `$env:KUBECONFIG = "kubeslice/kubeconfig.yaml"`
:::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ These release notes describe the new changes and enhancements in this version.
Namespaces that are created to run application deployments can be onboarded on a slice to form a micro
network segment. Once a namespace is bound to a slice, all the pods that get scheduled in
the namespace would get connected to the slice. The configuration is part of the slice YAML file.
This feature onboards namespaces and not indivdiual applications.
This feature onboards namespaces and not individual applications.

## Breaking Change for Onboarding Applications
With the onboarding namespaces feature, onboarding each application is no longer supported.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ The following are the kubeslice-cli options.
:::note
The kubeslice-cli tool must have access to the clusters you want it to manage. To grant it access, set the KUBECONFIG environment variable
to a path to the kubeconfig file containing the necessary keys to access those clusters.
To set the KUBECONFIG environment varible, use these commands:
To set the KUBECONFIG environment variable, use these commands:
- On Linux/macOS: `export KUBECONFIG=<path to kubeconfig file>`
- On Windows: `$env:KUBECONFIG = "kubeslice/kubeconfig.yaml"`
:::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ These release notes describe the new changes and enhancements in this version.
Namespaces that are created to run application deployments can be onboarded on a slice to form a micro
network segment. Once a namespace is bound to a slice, all the pods that get scheduled in
the namespace would get connected to the slice. The configuration is part of the slice YAML file.
This feature onboards namespaces and not indivdiual applications.
This feature onboards namespaces and not individual applications.

## Breaking Change for Onboarding Applications
With the onboarding namespaces feature, onboarding each application is no longer supported.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ The following are the kubeslice-cli options.
:::note
The kubeslice-cli tool must have access to the clusters you want it to manage. To grant it access, set the KUBECONFIG environment variable
to a path to the kubeconfig file containing the necessary keys to access those clusters.
To set the KUBECONFIG environment varible, use these commands:
To set the KUBECONFIG environment variable, use these commands:
- On Linux/macOS: `export KUBECONFIG=<path to kubeconfig file>`
- On Windows: `$env:KUBECONFIG = "kubeslice/kubeconfig.yaml"`
:::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ The following information is required to run the script.

2. Open the terminal where you have `kubectl` on PATH and set the context to the cluster for which you want to create the config.

### Retreive Network Interface
### Retrieve Network Interface
3. Get the name of the network interface on the gateway nodes that is the egress interface for external traffic.
:::warning
The below command does not work for OpenShift clusters.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ The following information is required to run the script.

2. Open the terminal where you have `kubectl` on PATH and set the context to the cluster for which you want to create the config.

### Retreive Network Interface
### Retrieve Network Interface
3. Get the name of the network interface on the gateway nodes that is the egress interface for external traffic.
:::warning
The below command does not work for OpenShift clusters.
Expand Down
Loading

0 comments on commit c6b4f4f

Please sign in to comment.