You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/pages/getting-started/3-exploring-components.mdx
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -93,7 +93,7 @@ and give us autocompletion and validation.
93
93
</FileTree>
94
94
95
95
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.
97
97
98
98
```bash copy
99
99
confix build
@@ -123,14 +123,14 @@ Output:
123
123
```
124
124
125
125
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.
127
127
128
128

129
129
130
130
## Using input providers
131
131
132
132
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
134
134
based on the result. We will use the `graphql` provider to generate a schema based on a GraphQL
135
135
file.
136
136
@@ -251,11 +251,11 @@ You can ship the component together with the package and confix automatically re
251
251
252
252
This has some advantages:
253
253
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.
255
255
- There is no external component needed (like a git repository). You just reference the package and you are good to go.
256
256
257
257
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.
259
259
260
260
Secondly, we need to tell confix to look for components in the package. For this we use a "component provider".
261
261
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.
299
299
<Steps>
300
300
### Creating the package
301
301
302
-
Naviagate to the /src folder and execute the following command:
302
+
Navigate to the /src folder and execute the following command:
Copy file name to clipboardExpand all lines: docs/pages/getting-started/4-using-variables.mdx
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -72,12 +72,12 @@ Explore more about variable providers in the [variable documentation](/variables
72
72
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.
73
73
74
74
<Callouttype="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
76
76
[`azure-keyvault`](/variables/azure-keyvault) or the
77
77
[`secret`](/variables/secrets) provider to secure your sensitive data.
78
78
</Callout>
79
79
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`:
81
81
82
82
```json filename=".confixrc" copy
83
83
{
@@ -117,8 +117,8 @@ As explained before, to discover variables we need to config `variableProviders`
117
117
118
118
## Defining variables
119
119
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 `.`.
122
122
123
123
Lets set the variable `$example:Website.Url`
124
124
@@ -206,7 +206,7 @@ confix variable list
206
206
</Tab>
207
207
</Tabs>
208
208
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.
210
210
211
211
<Tabsitems={["VSCode", "Command", "Output"]}>
212
212
<Tab>
@@ -256,8 +256,8 @@ Up until now, we've only defined variables. Now we'll use them in our configurat
256
256
}
257
257
```
258
258
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.
0 commit comments