Skip to content

Commit 835eec2

Browse files
change to sentence capitalization
1 parent 57ecc21 commit 835eec2

26 files changed

+112
-138
lines changed

documentation/1.9/content/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,9 @@ See the [Release Notes]({{< relref "/release-notes.md" >}}) for known issues and
5050
This documentation includes sections targeted to different audiences:
5151

5252
* [Concepts]({{< relref "/concepts/" >}}) explains the underlying metadata models and archive files.
53-
* The [User guide]({{< relref "/userguide/" >}}) contains detailed usage information, including how to install and configure WebLogic Deploy Tooling, and how to use each tool.
53+
* The [User Guide]({{< relref "/userguide/" >}}) contains detailed usage information, including how to install and configure WebLogic Deploy Tooling, and how to use each tool.
5454
* The [Samples]({{< relref "/samples/" >}}) provide informative use case scenarios.
55-
* The [Developer guide]({{< relref "/developer/" >}}) provides details for people who want to understand how WDT is built, its features mapped and implemented.
55+
* The [Developer Guide]({{< relref "/developer/" >}}) provides details for people who want to understand how WDT is built, its features mapped and implemented.
5656

5757
### Related projects
5858

documentation/1.9/content/concepts/archive.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ Note that file resources that already exist on the target system need not be inc
1313
### Contents
1414

1515
- [Example](#example)
16-
- [Archive Structure](#archive-structure)
17-
- [Using Multiple Archive Files](#using-multiple-archive-files)
16+
- [Archive structure](#archive-structure)
17+
- [Using multiple archive files](#using-multiple-archive-files)
1818

1919
#### Example
2020

@@ -31,7 +31,7 @@ appDeployments:
3131
3232
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 in the domain, in this case `<domain-home>/wlsdeploy/applications/simpleear.ear`.
3333

34-
### Archive Structure
34+
### Archive structure
3535

3636
These are the paths within the archive that are used for different types of resources. Users can create further directory structures underneath these locations to organize the files and directories as they see fit.
3737

@@ -85,7 +85,7 @@ The root directory under which shared libraries are stored. These are stored as
8585
#### `wlsdeploy/stores`
8686
The root directory under which empty directories must exist for `FileStore` elements in the model.
8787

88-
### Using Multiple Archive Files
88+
### Using multiple archive files
8989

9090
The Create Domain, Update Domain, Deploy Applications, and Validate Model Tools allow the specification of multiple archive files on the command line. For example:
9191

documentation/1.9/content/concepts/model.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ weight: 1
88
### Contents
99

1010
- [Overview](#overview)
11-
- [Top-Level Sections](#top-level-model-sections)
12-
- [Simple Example](#simple-example)
13-
- [Model Names](#model-names)
14-
- [Model Tokens](#model-tokens)
15-
- [Model Semantics](#model-semantics)
16-
- [Declaring Named MBeans to Delete](#declaring-named-mbeans-to-delete)
17-
- [Using Multiple Models](#using-multiple-models)
11+
- [Top-level sections](#top-level-model-sections)
12+
- [Simple example](#simple-example)
13+
- [Model names](#model-names)
14+
- [Model tokens](#model-tokens)
15+
- [Model semantics](#model-semantics)
16+
- [Declaring named MBeans to delete](#declaring-named-mbeans-to-delete)
17+
- [Using multiple models](#using-multiple-models)
1818

1919
### Overview
2020

@@ -44,7 +44,7 @@ The model is written in YAML (or optionally, JSON). The YAML parser, built into
4444
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.
4545

4646

47-
### Top-Level Model Sections
47+
### Top-level model sections
4848
The tooling has five top-level model sections:
4949

5050
- `domainInfo` - The location where special information not represented in WLST is specified (for example, the libraries that go in `$DOMAIN_HOME/lib`).
@@ -53,7 +53,7 @@ The tooling has five top-level model sections:
5353
- `appDeployments` - The location where shared libraries and applications are specified.
5454
- `kubernetes` - The location where the WLS Kubernetes Operator domain configuration is specified.
5555

56-
#### Simple Example
56+
#### Simple example
5757
Here is a simple example of a model to deploy an application and its data source:
5858

5959
```yaml
@@ -88,17 +88,17 @@ appDeployments:
8888
ModuleType: war
8989
```
9090
91-
The above example shows two important features of the framework. First, notice that the `URL`, `PasswordEncrypted`, `user` property `Value` and all `Target` fields contain values that have a `@@PROP:<name>@@` pattern. This indicates a variable placeholder whose value is specified at runtime using a variables file. See [Model Tokens](#model-tokens) for more information about this and other token types.
91+
The above example shows two important features of the framework. First, notice that the `URL`, `PasswordEncrypted`, `user` property `Value` and all `Target` fields contain values that have a `@@PROP:<name>@@` pattern. This indicates a variable placeholder whose value is specified at runtime using a variables file. See [Model tokens](#model-tokens) for more information about this and other token types.
9292

93-
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.
93+
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.
9494

95-
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.
95+
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.
9696

9797
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.
9898

9999
One final note is that the framework is written in such a way to allow the model to be extended for use by other tools. Adding other top-level sections to the model is supported and the existing tooling and framework will simply ignore them, if present. For example, it would be possible to add a `soaComposites` section to the model where SOA composite applications are described, and a location within the archive file where those binaries can be stored, so that a tool that understands SOA composites and how to deploy them could be run against the same model and archive files.
100100

101-
### Model Names
101+
### Model names
102102

103103
The WebLogic Deploy Tooling handles names of WebLogic Server configuration artifacts in a very prescribed way. To understand how names are handled, users first need a basic understanding of WLST offline naming. In WLST offline, there are two general categories of configuration artifacts:
104104

@@ -131,7 +131,7 @@ topology:
131131

132132
As the example above shows, the `SecurityConfiguration` element has no named sub-element, as there is with `JDBCSystemResource`, even though the WLST path to the `SecurityConfiguration` attributes is `/SecurityConfiguration/<domain-name>`. The WebLogic Deploy Tooling has built-in rules and a knowledge base that controls how these names are handled so that it can complete the configuration of these artifacts. As with the previous class of configuration artifact, the folder almost always contains a ` Name` attribute that, in WLST, could be used to change the name. As with the previous class of artifact, the WebLogic Deploy Tooling does not support the use of the `Name` attribute in these folders and any attempt to set the `Name` attribute will not be honored. In general, the only model location that uses the `Name` attribute is the top-level topology section, because this maps to where WLST stores the domain name.
133133

134-
### Model Tokens
134+
### Model tokens
135135

136136
The model allows the use of tokens that are substituted with text values as the model is processed. This section describes several types of tokens.
137137

@@ -186,7 +186,7 @@ Using the path token `@@WL_HOME@@` allows the model to be used across multiple e
186186
- `@@PWD@@` - The current working directory from which the tool was invoked.
187187
- `@@TMP@@` - The location of the temporary directory, as controlled by the `java.io.tmpdir` system property.
188188

189-
### Model Semantics
189+
### Model semantics
190190

191191
When modeling configuration attributes that can have multiple values, the WebLogic Deploy Tooling tries to make this as painless as possible. For example, the `Target` attribute on resources can have zero or more clusters and/or servers specified. When specifying the value of such list attributes, the user has freedom to specify them as a list or as a comma-delimited string (comma is the only recognized delimiter for lists). For attributes where the values can legally contain commas, the items must be specified as a list. Examples of each are shown below.
192192

@@ -224,7 +224,7 @@ In the example above, the `Target` attribute is specified three different ways,
224224

225225
One of the primary goals of the WebLogic Deploy Tooling is to support a sparse model where the user can specify just the configuration needed for a particular situation. What this implies varies somewhat between the tools but, in general, this implies that the tools are using an additive model. That is, the tools add to what is already there in the existing domain or domain templates (when creating a new domain) rather than making the domain conform exactly to the specified model. Where it makes sense, a similar, additive approach is taken when setting the value of multi-valued attributes. For example, if the model specified the cluster `mycluster` as the target for an artifact, the tooling will add `mycluster` to any existing list of targets for the artifact. While the development team has tried to mark attributes that do not make sense to merge accordingly in our knowledge base, this behavior can be disabled on an attribute-by-attribute basis, by adding an additional annotation in the knowledge base data files. The development team is already thinking about how to handle situations that require a non-additive, converge-to-the-model approach, and how that might be supported, but this still remains a wish list item. Users with these requirements should raise an issue for this support.
226226

227-
### Declaring Named MBeans to Delete
227+
### Declaring named MBeans to delete
228228

229229
With WebLogic Deploy Tooling release 1.3.0, you can specify named items in the model to be deleted using the Create Domain, Update Domain, and Deploy Applications Tools. Named items are those that have multiple instances that are distinguished by user-provided names, such as managed servers, data sources, and security realms. Items to be deleted are prepended with an exclamation point (!) in the model.
230230

@@ -257,11 +257,11 @@ This feature can also remove items that were created by WebLogic Server template
257257
...
258258
```
259259

260-
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 "/samples/securityproviders-model.md" >}}) for detailed information.
260+
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 "/samples/securityproviders-model.md" >}}) for detailed information.
261261

262262
This feature cannot be use to un-deploy applications or remove libraries.
263263

264-
### Using Multiple Models
264+
### Using multiple models
265265

266266
The Create Domain, Update Domain, Deploy Applications, and Validate Model Tools allow the specification of multiple models on the command line. For example:
267267

@@ -304,7 +304,7 @@ topology:
304304

305305
If variable properties are used in element names, such as ```@@PROP:my-server@@```, the names in both models will be resolved and matching elements will be merged.
306306

307-
#### Multiple Models and Delete Notation
307+
#### Multiple models and delete notation
308308

309309
A named element using [delete notation](#declaring-named-mbeans-to-delete) will completely delete an element with a matching name and no delete notation in a previous model. For example, if Model 1 looks like:
310310
```yaml

documentation/1.9/content/developer/ReleaseProcess.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ This document describes the process that should be followed to create a WebLogic
2222
</servers>
2323
```
2424

25-
### Software Release Process
25+
### Software release process
2626
The best practice is to write the release notes that will be published to GitHub prior to starting the steps below.
2727

2828
1. Set (and export) the environment variable `WLST_DIR` to `<WLS-install-dir>/oracle_common/common/bin`, replacing `<WLS-install-dir>` with the full path to the WLS 12.2.1.x installation directory.
@@ -38,7 +38,7 @@ developmentVersion=1.9.12-SNAPSHOT
3838
4. If the build fails, run the `mvn -B -P release release:rollback` command to undo it and start over from Step 2., after correcting the issue.
3939
5. After the software has been released, move on to the GitHub Release Process.
4040

41-
### GitHub Release Process
41+
### GitHub release process
4242
Note that this process relies on the WDT installers being in your local Maven repository. As such, it is critical for the same user to run these steps on the same machine as the steps from the previous section!
4343

4444
1. Save the release notes in the file `<wdt-project-directory>/target/ReleaseNotes.md`.

documentation/1.9/content/developer/alias-definitions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ The dictionary key defines the various WLST path values used elsewhere in this f
9898

9999
The `%DATASOURCE%` text is token placeholder. It will be replaced with the name of the actual data source by the tool.
100100

101-
### Keys for `attributes` Elements
101+
### Keys for `attributes` elements
102102

103103
Each child of an `attributes` element represents a single MBean attribute, and its key is the corresponding model name, such as `CapacityIncrement`. It contains at least one description element with the JSON keys below. There may be multiple description elements for cases where the configuration varies for different WebLogic Server version ranges, or varies between offline and online WLST.
104104

documentation/1.9/content/developer/buildWDT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ You will need the following software installed in your local build environment:
1313
* JDK version 8
1414
* Maven 3 and later
1515

16-
#### Specifying the WLST location
16+
#### Specify the WLST location
1717

1818
Execution of the unit tests requires a WebLogic Server installation, because the tests must be run within WLST.
1919

documentation/1.9/content/rcuinfo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ domainInfo:
4949
rcu_variables : 'xxxx'
5050
```
5151

52-
**Note: Prior to release 0.23, the useATP flag only accepts values of 0, 1, 'true' or 'false'.**
52+
**Note: Prior to release 0.23, the `useATP` flag only accepts values of 0, 1, 'true' or 'false'.**
5353

5454
When creating a domain using WDT and the -run_rcu option, you can specify your extended XML files in the RCUDbInfo section.
5555

0 commit comments

Comments
 (0)