Skip to content

Commit da7cdbe

Browse files
tsinghammerCarael
andauthored
Fix some typos in documentation (#170)
Some typos I came across while reading the docs. Co-authored-by: Mariusz Matysek <mariuszmatysek@gmail.com>
1 parent c99621a commit da7cdbe

14 files changed

Lines changed: 31 additions & 31 deletions

docs/pages/components.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ project whenever you 'restore' the project. As you bundle the code/binaries of t
111111
with the component on build time, you guarantee that you configuration always matches the used
112112
version of the component.
113113

114-
There is currenlty only one component provider available, `dotnet-package`, which scans the
114+
There is currently only one component provider available, `dotnet-package`, which scans the
115115
project's assemblies for embedded resources describing a Confix component.
116116
But we are open to add more component providers in the future, such as `node-modules`, which checks
117117
the node-modules used by the project for Confix components.
@@ -184,7 +184,7 @@ confix component list
184184
- Other
185185
```
186186

187-
You can also define a `--format` to export the conmponent as json
187+
You can also define a `--format` to export the component as json
188188

189189
```bash
190190
confix component list --format json

docs/pages/components/assets/component-intelisense.png renamed to docs/pages/components/assets/component-intellisense.png

File renamed without changes.

docs/pages/components/inputs.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ In the folder with the `.confix.project` file, we can now run:
5959
confix component init Authorization
6060
```
6161

62-
This will generate the `Authroization` component for us. The file structure will look like this:
62+
This will generate the `Authorization` component for us. The file structure will look like this:
6363

6464
<FileTree>
6565
<FileTree.Folder name="/" defaultOpen>
@@ -151,14 +151,14 @@ We will get error messages that the appsetting.json file is missing the `Authori
151151
</FileTree>
152152

153153
When we open the root folder now in VSCode, we get intellisense for the `appsettings.json` file.
154-
![Component intelisense](./assets/component-intelisense.png)
154+
![Component intellisense](./assets/component-intellisense.png)
155155

156156
## Supported Component Inputs:
157157

158158
Here is a list of currently supported component inputs:
159159

160160
Currently supporter components inputs are:
161-
|Name|Descripion|
161+
|Name|Description|
162162
|---|---|
163163
|`graphql`|Allows you to define a graphql file which can be used to define the json schema
164-
|`dotnet`| This will add the components as an embedded resouource to the .net project that defines the component
164+
|`dotnet`| This will add the components as an embedded resource to the .net project that defines the component

docs/pages/components/providers/dotnet-package.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Dotnet Package
22

3-
This provider reads components that are embeded in a .NET package and distributed through a package
3+
This provider reads components that are embedded in a .NET package and distributed through a package
44
repository.
55

66
You can read more about components in [Components](./components)

docs/pages/components/providers/git.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Git
22

33
Use this provider to access components that located in a separate repository.
4-
This is useful to share compone across multiple repositories without having to
4+
This is useful to share components across multiple repositories without having to
55
distribute them as a package.
66

77
Components can be added to a project by executing:

docs/pages/components/providers/local.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { FileTree } from "nextra-theme-docs";
33

44
# Local
55

6-
The local provider is implicity added to the list of providers without the need for any configuration.
6+
The local provider is implicitly added to the list of providers without the need for any configuration.
77
It provides the project will all components that are available in the current project.
88

99
## Example

docs/pages/getting-started.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,6 @@ Create and tailor environments to ensure your configuration thrives in multiple
2626

2727
### [Deploying Your Application](/getting-started/6-deploying-your-application)
2828

29-
We are going to look into various deployment strategies and learn how to bring your application to produciton.
29+
We are going to look into various deployment strategies and learn how to bring your application to production.
3030

3131
</Steps>

docs/pages/getting-started/2-first-configuration.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { FileTree } from "nextra-theme-docs";
55
This guide will walk you through setting up a simple
66
[.net core project](https://dotnet.microsoft.com) to show you how to work with Confix. Confix is
77
versatile and
8-
can work with any language or framework, making it a handy tool for your project aswell.
8+
can work with any language or framework, making it a handy tool for your project as well.
99

1010
There might be some limitations depending on your particular needs. Feel free to get in touch with
1111
us if you're keen on using Confix with your preferred framework, and we'll be happy to help.
@@ -32,7 +32,7 @@ potential for expansion to cover new requirements. Like with other modular syste
3232
initial setup is required to align Confix with your project's needs.
3333

3434
The configuration details for Confix are in a file named `.confixrc`. This file is organized into
35-
two main sections; namley "component" and "project".
35+
two main sections; namely "component" and "project".
3636

3737
- The "component" section defines configuration for Confix [Components](/components)
3838
- In the "project" section, you can define configuration for your project

docs/pages/getting-started/3-exploring-components.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ and give us autocompletion and validation.
9393
</FileTree>
9494

9595
When we run the command `confix build` in the `Website` folder we now see that our component is
96-
loaded and that the configuration we have is applied.
96+
loaded and that the configuration we have created is applied.
9797

9898
```bash copy
9999
confix build
@@ -123,14 +123,14 @@ Output:
123123
```
124124

125125
When we open the `appsettings.json` file we see that the configuration was initialized and `Url` is
126-
set to `null`. The intelisense tells us that the `Url` cannot be empty and has to have a value.
126+
set to `null`. The intellisense tells us that the `Url` cannot be empty and has to have a value.
127127

128128
![VSCode](./assets/exploring-components-1.png)
129129

130130
## Using input providers
131131

132132
Defining JSON schemas is a pain. It's a lot of work and it's easy to make mistakes. Confix has a
133-
features called `Component Inputs`. These allow you to process components and generate a schema
133+
feature called `Component Inputs`. These allow you to process components and generate a schema
134134
based on the result. We will use the `graphql` provider to generate a schema based on a GraphQL
135135
file.
136136

@@ -251,11 +251,11 @@ You can ship the component together with the package and confix automatically re
251251

252252
This has some advantages:
253253

254-
- The component is versioned together with the source code. This means that you can evolve the shape of the configuration together with the component. If you decide to introduce a breaking change in the configuration, once you upgrade the package to theis version, confix will tell you that the configuration is invalid.
254+
- The component is versioned together with the source code. This means that you can evolve the shape of the configuration together with the component. If you decide to introduce a breaking change in the configuration, once you upgrade the package to this version, confix will tell you that the configuration is invalid.
255255
- There is no external component needed (like a git repository). You just reference the package and you are good to go.
256256

257257
First, to make the components discoverable in .NET, we need a special "component input".
258-
This input will registry the component as a embedded resource in the package.
258+
This input will register the component as a embedded resource in the package.
259259

260260
Secondly, we need to tell confix to look for components in the package. For this we use a "component provider".
261261
Component providers are responsible for loading components from different sources e.g. `git` or packages
@@ -299,7 +299,7 @@ Lets create a shared database component.
299299
<Steps>
300300
### Creating the package
301301

302-
Naviagate to the /src folder and execute the following command:
302+
Navigate to the /src folder and execute the following command:
303303

304304
```bash copy
305305
cd src
@@ -308,9 +308,9 @@ cd Database
308308
dotnet add package Microsoft.Extensions.DependencyInjection
309309
```
310310

311-
### Add a extension method
311+
### Add an extension method
312312

313-
Add a extension method to the class library that registers the component.
313+
Add an extension method to the class library that registers the component.
314314

315315
```csharp filename="src/Database/DatabaseServiceCollectionExtensions.cs" copy
316316
using Microsoft.Extensions.DependencyInjection;

docs/pages/getting-started/4-using-variables.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -72,12 +72,12 @@ Explore more about variable providers in the [variable documentation](/variables
7272
For simplicity, we'll use the `local` variable provider to store our `ConnectionString` and `Url` values. This is obviously not a secure approach, but it's a good starting point to explain how the providers work.
7373

7474
<Callout type="info">
75-
In a real scenario you probably want to use something like the
75+
In a real world scenario you probably want to use something like the
7676
[`azure-keyvault`](/variables/azure-keyvault) or the
7777
[`secret`](/variables/secrets) provider to secure your sensitive data.
7878
</Callout>
7979

80-
As explained before, to discover variables we need to config `variableProviders`. We have to add this to the `.confixrc`:
80+
As explained before, to discover variables we need to configure `variableProviders`. We have to add this to the `.confixrc`:
8181

8282
```json filename=".confixrc" copy
8383
{
@@ -117,8 +117,8 @@ As explained before, to discover variables we need to config `variableProviders`
117117

118118
## Defining variables
119119

120-
The variable provider `example` of the type `local` is configured to use the file `variables.json` in the project direcotries.
121-
Variables always start `${name}:` (in out case `$example:`) and then are followed by a path separated by `.`.
120+
The variable provider `example` of the type `local` is configured to use the file `variables.json` in the project directories.
121+
Variables always start with `${name}:` (in out case `$example:`) and then are followed by a path separated by `.`.
122122

123123
Lets set the variable `$example:Website.Url`
124124

@@ -206,7 +206,7 @@ confix variable list
206206
</Tab>
207207
</Tabs>
208208

209-
When we do a `confix restore` the variables become available as intellisense the configuration file.
209+
When we do a `confix restore` the variables become available as intellisense in the configuration file.
210210

211211
<Tabs items={["VSCode", "Command", "Output"]}>
212212
<Tab>
@@ -256,8 +256,8 @@ Up until now, we've only defined variables. Now we'll use them in our configurat
256256
}
257257
```
258258

259-
When we now run 'confix build' the variables are replaced with the values from the variable provider.
260-
As we use the `appsettings` configuration file, the variables are not replaced in the `appsettings.json` but stored in user secrets.
259+
When we now run 'confix build' the variables are being replaced with the values from the variable provider.
260+
Since we are using the `appsettings` configuration file, the variables are not replaced in the `appsettings.json` but stored in user secrets.
261261

262262
<Tabs items={["appsettings.json", "usersecrets.json", "Command", "Output"]}>
263263
<Tab>

0 commit comments

Comments
 (0)