Skip to content

Commit 1e1d8aa

Browse files
fix x-refs
1 parent 863d570 commit 1e1d8aa

19 files changed

+76
-97
lines changed

documentation/1.9/content/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ See the [Release Notes]({{< relref "/release-notes.md" >}}) for recent changes,
1818

1919
This documentation includes sections targeted to different audiences. To help you find what you are looking for more easily, please consult this table of contents:
2020

21-
* [Concepts]({{< relref "/concepts/" >}}) explains the underlying metadata model, files, and configurations.
22-
* The [User guide]({{< relref "/userguide/" >}}) contains detailed usage information, including how to install and configure WebLogic Deploy Tooling, and how to use the tools to .
21+
* [Concepts]({{< relref "/concepts/" >}}) explains the underlying metadata model, files, and configurations...
22+
* The [User guide]({{< relref "/userguide/" >}}) contains detailed usage information, including how to install and configure WebLogic Deploy Tooling, and how to use each tool.
2323
* The [Samples]({{< relref "/samples/" >}}) provide detailed example code and instructions that show you how to perform various tasks.
2424
* The [Developer guide]({{< relref "/developer/" >}}) provides details for people who want to understand how WDT is built, tested, and so on.
2525

documentation/1.9/content/concepts/archive.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ The archive file is used to deploy binaries and other file resources to the targ
1010

1111
Note that file resources that already exist on the target system need not be included in the archive, provided that the model specifies the correct location on the target system.
1212

13+
### Contents
14+
1315
- [Example](#example)
1416
- [Archive Structure](#archive-structure)
1517
- [Using Multiple Archive Files](#using-multiple-archive-files)

documentation/1.9/content/concepts/model.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The model is written in YAML (or optionally, JSON). The YAML parser, built into
3131

3232
All assignment statements must have one or more spaces between the colon and the value. All comments must have a space after the pound sign (also known as hash) to be considered a comment. YAML doesn't allow comments in all locations. While the YAML parser used by the framework does not try to enforce these restrictions, it is likely that putting comments in some locations may cause parse errors since YAML is a difficult language to parse due to its complex indention rules.
3333

34-
#### Contents
34+
### Contents
3535

3636
- [Top-Level Sections](#top-level-model-sections)
3737
- [Simple Example](#simple-example)
@@ -50,7 +50,7 @@ The tooling has five top-level model sections:
5050
- `appDeployments` - The location where shared libraries and applications are specified.
5151
- `kubernetes` - The location where the WLS Kubernetes Operator domain configuration is specified.
5252

53-
### Simple Example
53+
#### Simple Example
5454
Here is a simple example of a model to deploy an application and its data source:
5555

5656
```yaml
@@ -89,7 +89,7 @@ The above example shows two important features of the framework. First, notice
8989

9090
Second, notice that the `jsf#2.0` shared library `SourcePath` attribute value starts with `@@WL_HOME@@`. This is a path token that can be used to specify that the location is relative to the location of the WebLogic Server home directory on the target environment. See [Model Tokens](#model-tokens) for more information and a list of available path tokens.
9191

92-
The example above shows the attribute `SourcePath` of the `simpleear` application with a value of `wlsdeploy/applications/simpleear.ear`. The prefix `wlsdeploy/` indicates that the resource is located in the archive file in the specified location, and will be deployed to that directory within the domain, in this case `<domain-home>/wlsdeploy/applications/simpleear.ear`. See [The Archive File](archive.md) for more details about using the archive file.
92+
The example above shows the attribute `SourcePath` of the `simpleear` application with a value of `wlsdeploy/applications/simpleear.ear`. The prefix `wlsdeploy/` indicates that the resource is located in the archive file in the specified location, and will be deployed to that directory within the domain, in this case `<domain-home>/wlsdeploy/applications/simpleear.ear`. See [The Archive File]({{< relref "/concepts/archive.md" >}}) for more details about using the archive file.
9393

9494
Users can create further directory structures underneath the above locations to organize the files and directories as they see fit. Note that any binary that already exists on the target system need not be included in the archive provided that the model specified the correct location on the target system.
9595

@@ -254,7 +254,7 @@ This feature can also remove items that were created by WebLogic Server template
254254
...
255255
```
256256

257-
This feature does not apply to named security providers within a realm. These items follow a special set of rules that are required to maintain their ordering. See [Modeling Security Providers](use_cases.md#modeling-security-providers) for detailed information.
257+
This feature does not apply to named security providers within a realm. These items follow a special set of rules that are required to maintain their ordering. See [Modeling Security Providers]({{< relref "/concepts/use_cases#modeling-security-providers" >}}) for detailed information.
258258

259259
This feature cannot be use to un-deploy applications or remove libraries.
260260

documentation/1.9/content/concepts/target_env.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ weight: 5
66
---
77

88

9-
The [Discover Domain]({{< relref "/discover.md" >}}) and [Prepare Model]({{< relref "/prepare.md" >}}) Tools allow you to customize the model and other files produced to be compatible with a specific target environment. Options for a target environment may include:
10-
- Using model tokens for some attributes in the model (see [Model Tokens]({{< relref "/model#model-tokens" >}}))
11-
- Using Kubernetes secrets for credentials in the model
12-
- Applying filters to the model (see [Model Filters]({{< relref "/tool_configuration#model-filters" >}}))
13-
- Creating additional configuration files for the target system
9+
The [Discover Domain]({{< relref "/userguide/tools/discover.md" >}}) and [Prepare Model]({{< relref "/userguide/tools/prepare.md" >}}) Tools allow you to customize the model and other files produced to be compatible with a specific target environment. Options for a target environment may include:
10+
- Using model tokens for some attributes in the model. See [Model Tokens]({{< relref "/concepts/model#model-tokens" >}}).
11+
- Using Kubernetes secrets for credentials in the model.
12+
- Applying filters to the model. See [Model Filters]({{< relref "/concepts/tool_configuration#model-filters" >}}).
13+
- Creating additional configuration files for the target system.
1414

1515
### Specifying a target environment
1616

@@ -31,10 +31,10 @@ A target environment is configured in a JSON file at this location:
3131
$WLSDEPLOY_HOME/lib/target/<target-name>/target.json
3232
```
3333
The `<target-name>` value corresponds to the value of the `-target` argument on the tool's command line. The WLS installation includes two pre-defined targets:
34-
- [Oracle Weblogic Server Kubernetes Operator](#the-oracle-weblogic-server-kubernetes-operator-target) (named `k8s`)
34+
- [Weblogic Kubernetes Operator](#the-weblogic-kubernetes-operator-target) (named `k8s`)
3535
- [Verrazzano](#the-verrazzano-target) (named `vz`).
3636

37-
You can define a new or extended target environment with a new `target-name` in the above location, or using a [Custom Configuration](../tool_configuration.md#custom-configuration) directory, such as `$WDT_CUSTOM_CONFIG/target/<my-target-name>/target.json`.
37+
You can define a new or extended target environment with a new `target-name` in the above location, or using a [Custom Configuration]({{< relref "/concepts/tool_configuration#custom-configuration" >}}) directory, such as `$WDT_CUSTOM_CONFIG/target/<my-target-name>/target.json`.
3838

3939
Here is an example of a target environment file:
4040
```
@@ -55,13 +55,13 @@ Each of the fields in this example is optional, and can be customized.
5555

5656
#### `model_filters`
5757

58-
This field specifies the filters to be applied to the resulting model. This follows the same format and rules as the [Model Filters](../tool_configuration.md#model-filters) configuration. The `discover` type should always be used here.
58+
This field specifies the filters to be applied to the resulting model. This follows the same format and rules as the [Model Filters]({{< relref "/concepts/tool_configuration#model-filters" >}}) configuration. The `discover` type should always be used here.
5959

6060
The `@@TARGET_CONFIG_DIR@@` token can be used to indicate that the specified filter is in the same directory as the target configuration file.
6161

6262
#### `variable_injectors`
6363

64-
This field specifies the variable injectors to be applied to the resulting model. This follows the same format and rules as the [Variable Injectors](../variable_injection.md) configuration.
64+
This field specifies the variable injectors to be applied to the resulting model. This follows the same format and rules as the [Variable Injectors]({{< relref "/userguide/tools/variable_injection.md" >}}) configuration.
6565

6666
#### `validation_method`
6767

@@ -77,7 +77,7 @@ In both these cases, the script to create the Kubernetes secrets is written to `
7777

7878
#### `wls_credentials_name`
7979

80-
This field specifies a name for use with the WDT_MODEL_SECRETS_NAME_DIR_PAIRS environment variable to identify administration credential Secrets for the domain. This is useful when those Secrets are stored in a directory that does not follow the `<directory>/<name>/<key>` convention. For more information about using the WDT_MODEL_SECRETS_NAME_DIR_PAIRS environment variable, see [Model Tokens](../model.md#model-tokens).
80+
This field specifies a name for use with the WDT_MODEL_SECRETS_NAME_DIR_PAIRS environment variable to identify administration credential Secrets for the domain. This is useful when those Secrets are stored in a directory that does not follow the `<directory>/<name>/<key>` convention. For more information about using the WDT_MODEL_SECRETS_NAME_DIR_PAIRS environment variable, see [Model Tokens]({{< relref "/concepts/model#model-tokens" >}}).
8181

8282
#### `additional_output`
8383

documentation/1.9/content/concepts/tool_configuration.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ weight: 4
99
#### Contents
1010
- [Tool Property File](#tool-property-file)
1111
- [Model Filters](#model-filters)
12-
- [Target Environments](config/target_env.md)
12+
- [Target Environments]({{< relref "/concepts/target_env.md" >}})
1313
- [Type Definitions](#domain-type-definitions)
14-
- [Variable Injection](variable_injection.md)
14+
- [Variable Injection]({{< relref "/userguide/tools/variable_injection.md" >}})
1515
- [Custom Configuration](#custom-configuration)
1616

1717
### Tool Property File
@@ -266,8 +266,8 @@ def filter_model(model):
266266
- [Tool Property File](#tool-property-file)
267267
- [Model Filters](#model-filters)
268268
- [Type Definitions](#domain-type-definitions) (See the [example](#example-extending-a-type-definition) below.)
269-
- [Variable Injection](variable_injection.md)
270-
- [The Prepare Model Tool](prepare.md) (target environments)
269+
- [Variable Injection]({{< relref "/userguide/tools/variable_injection.md" >}})
270+
- [The Prepare Model Tool]({{< relref "/userguide/tools/prepare.md" >}}) (target environments)
271271

272272
The WDT tools will look for each configuration file under `$WDT_CUSTOM_CONFIG` if specified, then under `$WLSDEPLOY_HOME/lib`.
273273

0 commit comments

Comments
 (0)