Skip to content

Commit e1f204f

Browse files
committed
Admin:config:yaml:includes Style updates
Signed-off-by: Lynette Miles <[email protected]>
1 parent 0722c85 commit e1f204f

File tree

1 file changed

+8
-12
lines changed

1 file changed

+8
-12
lines changed
Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
# Includes Section
1+
# Includes section
22

3-
The `includes` section allows you to specify additional YAML configuration files to be merged into the current configuration. These files are identified as a list of filenames and can include relative or absolute paths. If no absolute path is provided, the file is assumed to be located in a directory relative to the file that references it.
3+
The `includes` section lets you specify additional YAML configuration files to be merged into the current configuration. These files are identified as a list of filenames and can include relative or absolute paths. If no absolute path is provided, the file is assumed to be located in a directory relative to the file that references it.
44

5-
This feature is useful for organizing complex configurations into smaller, manageable files and including them as needed.
5+
Use this section to organizing complex configurations into smaller, manageable files and include them as needed.
66

7-
### Usage
7+
## Usage
88

9-
Below is an example demonstrating how to include additional YAML files using relative path references. This is the file system path structure
9+
The following example demonstrates how to include additional YAML files using relative path references. This is the file system path structure:
1010

11-
```
11+
```text
1212
├── fluent-bit.yaml
1313
├── inclusion-1.yaml
1414
└── subdir
@@ -23,10 +23,6 @@ includes:
2323
- subdir/inclusion-2.yaml
2424
```
2525
26-
## Key Points
27-
28-
- Relative Paths: If a path is not specified as absolute, it will be treated as relative to the file that includes it.
29-
30-
- Organized Configurations: Using the includes section helps keep your configuration modular and easier to maintain.
26+
Ensure that the included files are formatted correctly and contain valid YAML configurations for seamless integration.
3127
32-
> note: Ensure that the included files are formatted correctly and contain valid YAML configurations for seamless integration.
28+
If a path isn't specified as absolute, it will be treated as relative to the file that includes it.

0 commit comments

Comments
 (0)