Skip to content

Commit 9427cb5

Browse files
committed
Changed several headings to be sentence case
Ticket: ENT-9964 Signed-off-by: Ole Herman Schumacher Elgesem <[email protected]>
1 parent 67b3877 commit 9427cb5

File tree

116 files changed

+465
-465
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

116 files changed

+465
-465
lines changed

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -429,7 +429,7 @@ As a general note, avoiding abbreviations provides better readability.
429429

430430
## Technical reference documentation
431431

432-
* follow the [Policy Style Guide](guide/writing-and-serving-policy/policy-style.markdown)
432+
* follow the [Policy style guide](guide/writing-and-serving-policy/policy-style.markdown)
433433
in examples and code snippets
434434
* use the appropriate lexer for syntax highlighting via Pygments
435435

@@ -443,7 +443,7 @@ As a general note, avoiding abbreviations provides better readability.
443443
The structure of the technical documentation about CFEngine attributes,
444444
functions etc is as follows:
445445

446-
### Promise Attributes
446+
### Promise attributes
447447

448448
Promise attributes are documented within the respective promise types's reference
449449
page. Level-3 headers are used to start a new attribute (if the promise attribute
@@ -571,9 +571,9 @@ use the macro, and list the attributes explicitly:
571571
This argument does that.
572572

573573

574-
### Special Variables
574+
### Special variables
575575

576-
Special Variables are documented within the page of their context.
576+
Special variables are documented within the page of their context.
577577

578578
### context.variable
579579

api/enterprise-api-examples.markdown

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ tags: [examples, enterprise, REST, API, reporting]
1111
* [Managing settings][Managing settings]
1212
* [Browse host information][Browsing host information]
1313
* [Issue flexible SQL queries][SQL query examples] against data collected from hosts by the CFEngine Server
14-
* [Schedule reports][SQL query examples#Subscribed Query Example: Creating A Subscribed Query] for email and later download
14+
* [Schedule reports][SQL query examples#Subscribed query example: Creating a subscribed query] for email and later download
1515
* [Tracking changes performed by CFEngine][Tracking changes]
1616

1717
**See also:** [Enterprise API reference][Enterprise API reference]

api/enterprise-api-examples/browsing-host-information.markdown

+6-6
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ reports via [/api/query][Query REST API#Execute SQL query] for this. however, cu
1212
gathered from `cf-monitord`) is not part of the SQL reports data model.
1313

1414

15-
## Example: Listing Hosts With A Given Context
15+
## Example: Listing hosts with a given context
1616

1717
**Request**
1818

@@ -41,7 +41,7 @@ gathered from `cf-monitord`) is not part of the SQL reports data model.
4141
]
4242
}
4343

44-
## Example: Looking Up Hosts By Hostname
44+
## Example: Looking up hosts by hostname
4545

4646
Contexts, also known as classes, are powerful. You can use them to
4747
categorize hosts according to a rich set of tags. For example, each
@@ -74,7 +74,7 @@ for presentability).
7474
}
7575

7676

77-
#### Example: Looking Up Hosts By IP
77+
#### Example: Looking up hosts by IP
7878

7979
Similarly we can lookup the host with hostname
8080
`windows2008-2.test.cfengine.com` by IP as follows (lines split and indented
@@ -104,7 +104,7 @@ for presentability).
104104
}
105105

106106

107-
## Example: Removing Host Data
107+
## Example: Removing host data
108108

109109
If a host has been decommissioned from a Hub, we can explicitly remove data
110110
associated with the host from the Hub, by issuing a DELETE request (lines
@@ -123,7 +123,7 @@ SHA=1c8fafe478e05eec60fe08d2934415c81a51d2075aac27c9936e19012d625cb8 -X DELETE
123123

124124
**See also:** [Host REST API][Host REST API#remove host from the hub]
125125

126-
## Example: Listing Available Vital Signs For A Host
126+
## Example: Listing available vital signs for a host
127127

128128
Each host record on the Hub has a set of vital signs collected by `cf-monitord`
129129
on the agent. We can view the list of vitals signs from as host as follows
@@ -172,7 +172,7 @@ SHA=4e913e2f5ccf0c572b9573a83c4a992798cee170f5ee3019d489a201bc98a1a/vital
172172
},
173173
}
174174

175-
## Example: Retrieving Vital Sign Data
175+
## Example: Retrieving vital sign data
176176

177177
Each vital sign has a collected time series of values for up to one week. Here
178178
we retrieve the time series for the `mem_free` vital sign at host

api/enterprise-api-examples/managing-settings.markdown

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ are managed by the LDAP API and not this Settings API.
4949
204 No Content
5050

5151

52-
## Example: Changing The Log Level
52+
## Example: Changing the log level
5353

5454
The API uses standard Unix syslog to log a number of events. Additionally, log
5555
events are sent to `stderr`, which means they may also end up in your Apache

api/enterprise-api-examples/managing-users-and-roles.markdown

+6-6
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Roles are defined by regular expressions that determine which hosts the
1111
user can see, and what policy outcomes are restricted.
1212

1313

14-
## Example: Listing Users
14+
## Example: Listing users
1515

1616
**Request**
1717

@@ -47,7 +47,7 @@ user can see, and what policy outcomes are restricted.
4747
}
4848

4949

50-
## Example: Creating a New User
50+
## Example: Creating a new user
5151

5252
All users will be created for the internal user table. The API will never
5353
attempt to write to an external LDAP server.
@@ -68,7 +68,7 @@ attempt to write to an external LDAP server.
6868
}
6969

7070

71-
## Example: Updating an Existing User
71+
## Example: Updating an existing user
7272

7373
Both internal and external users may be updated. When updating an external
7474
users, the API will essentially annotate metadata for the user, it will never
@@ -84,7 +84,7 @@ credentials.
8484

8585
204 No Content
8686

87-
## Example: Retrieving a User
87+
## Example: Retrieving a user
8888

8989
It is possible to retrieve data on a single user instead of listing
9090
everything. The following query is similar to issuing `GET
@@ -116,7 +116,7 @@ a regular expression for `id`.
116116
]
117117
}
118118

119-
## Example: Adding a User to a Role
119+
## Example: Adding a user to a role
120120

121121
Adding a user to a role is just an update operation on the user. The full
122122
role-set is updated, so if you are only appending a role, you may want to
@@ -138,7 +138,7 @@ is used to remove a user from a role.
138138
}
139139

140140

141-
## Example: Deleting a User
141+
## Example: Deleting a user
142142

143143
Users can only be deleted from the internal users table.
144144

api/enterprise-api-examples/sql-queries.markdown

+4-4
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ published: true
55
tags: [examples, enterprise, rest, api, reporting, sql, queries]
66
---
77

8-
### Synchronous Example: Listing Hostname and IP for Ubuntu Hosts
8+
### Synchronous Example: Listing hostname and IP for Ubuntu hosts
99

1010
**Request:**
1111

@@ -57,7 +57,7 @@ curl -k --user admin:admin https://test.cfengine.com/api/query -X POST -d '{ "qu
5757
}
5858
```
5959

60-
### Subscribed Query Example: Creating A Subscribed Query
60+
### Subscribed query example: Creating a subscribed query
6161

6262
Here we create a new query to count file changes by name and have the result
6363
sent to us by email. The schedule field is any CFEngine context expression.
@@ -79,7 +79,7 @@ curl -k --user admin:admin https://test.cfengine.com/api/user/milton/ subscripti
7979
204 No Content
8080
```
8181

82-
### Subscribed Query Example: Listing Report Subscriptions
82+
### Subscribed query example: Listing report subscriptions
8383

8484
Milton can list all his current subscriptions by issuing the following.
8585

@@ -115,7 +115,7 @@ curl -k --user admin:admin https://test.cfengine.com/api/user/milton/subscriptio
115115
}
116116
```
117117

118-
### Subscribed Query Example: Removing A Report Subscription
118+
### Subscribed query example: Removing a report subscription
119119

120120
**Request:**
121121

api/enterprise-api-ref/export-import-api.markdown

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ tags: [reference, enterprise, API, import, export]
77

88
Import & export API provides users the ability to transfer Mission Portal data between hubs.
99

10-
**See also:** [Export/Import Settings UI][Settings#Export/Import]
10+
**See also:** [Export/import Settings UI][Settings#Export/import]
1111

1212
## Get available items to export
1313

api/enterprise-api-ref/federated-reporting-api.markdown

+5-5
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This API is used for configuring hubs so that a single hub can be used to report
1010
## Remote hubs
1111

1212
Federated reporting must be enabled before it is possible to use the remote hubs API, please
13-
see the `Enable hub for Federated reporting` section below.
13+
see the `Enable hub for federated reporting` section below.
1414

1515
### Remote hubs list
1616

@@ -157,9 +157,9 @@ HTTP 202 ACCEPTED
157157
HTTP 202 ACCEPTED
158158
```
159159

160-
## Enable hub for Federated reporting
160+
## Enable hub for federated reporting
161161

162-
### Enable hub as a Superhub
162+
### Enable hub as a superhub
163163

164164
**URI:** https://hub.cfengine.com/api/fr/setup-hub/superhub
165165

@@ -172,7 +172,7 @@ HTTP 202 ACCEPTED
172172
```
173173

174174

175-
### Enable hub as a Feeder
175+
### Enable hub as a feeder
176176

177177
**URI:** https://hub.cfengine.com/api/fr/setup-hub/feeder
178178

@@ -206,7 +206,7 @@ HTTP 202 ACCEPTED
206206
## Federation config
207207

208208
Federated reporting must be enabled before generating or removing federation configuration, please
209-
see `Enable hub for Federated reporting` section above. Otherwise an error will be thrown and
209+
see `Enable hub for federated reporting` section above. Otherwise an error will be thrown and
210210
config file will not be created/deleted.
211211

212212
### Generate federation config

api/enterprise-api-ref/host.markdown

+4-4
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,9 @@ Host API allows to access host specific information.
6868
* **firstseen**
6969
Time of receiving the first status report from the client. It is equivalent to the time when the client have been bootstrapped to the server for the first time. Represented as UNIX TIMESTAMP.
7070

71-
**Example usage:** `Example: Listing Hosts With A Given Context`, `Example: Looking Up Hosts By Hostname`, `Example: Looking Up Hosts By IP`
71+
**Example usage:** `Example: Listing hosts with a given context`, `Example: Looking up hosts by hostname`, `Example: Looking up hosts by IP`
7272

73-
## Host Details
73+
## Host details
7474

7575
**URI:** https://hub.cfengine.com/api/host/:host-id
7676

@@ -357,7 +357,7 @@ Note: Collecting monitoring data by default is disabled.
357357
* **units**
358358
Units for the samples.
359359

360-
**Example usage:** `Example: Listing Available Vital Signs For A Host`
360+
**Example usage:** `Example: Listing available vital signs for a host`
361361

362362
## Get samples from vital
363363

@@ -420,7 +420,7 @@ Note: Collecting monitoring data by default is disabled.
420420
* **values**
421421
Vital sign data. *(array of [ t, y ], where t is the sample timestamp)*
422422

423-
**Example usage:** `Example: Retrieving Vital Sign Data`
423+
**Example usage:** `Example: Retrieving vital sign data`
424424

425425

426426
## Get count of bootstrapped hosts by date range

api/enterprise-api-ref/inventory.markdown

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ tags: [reference, enterprise, API, reporting, URI]
66
---
77
Inventory API allows to access inventory reports and attributes dictionary.
88

9-
## Inventory Reports
9+
## Inventory reports
1010

1111

1212
**URI:** https://hub.cfengine.com/api/inventory

api/enterprise-api-ref/query.markdown

+1-1
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ API performance depend on the query result size, to achieve fastest results cons
8787
}
8888
```
8989

90-
**Example usage:** `Synchronous Example: Listing Hostname and IP for Ubuntu Hosts`
90+
**Example usage:** `Synchronous Example: Listing hostname and IP for Ubuntu hosts`
9191

9292
## Schedule SQL query as long running job
9393

api/enterprise-api-ref/status-settings.markdown

+1-1
Original file line numberDiff line numberDiff line change
@@ -154,4 +154,4 @@ administrator.
154154
}
155155
```
156156

157-
**Example usage:** `Example: Configuring LDAP`, `Example: Changing The Log Level`
157+
**Example usage:** `Example: Configuring LDAP`, `Example: Changing the log level`

api/enterprise-api-ref/users-rbac.markdown

+5-5
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ API call allowed only for administrator.
7676
* **external**
7777
Is user from external source (LDAP/AD).
7878

79-
**Example usage:** `Example: Listing Users`
79+
**Example usage:** `Example: Listing users`
8080

8181
## Get user data
8282

@@ -125,7 +125,7 @@ API call allowed only for administrator.
125125
* **time_zone**
126126
Time zone
127127

128-
**Example usage:** `Example: Retrieving a User`
128+
**Example usage:** `Example: Retrieving a user`
129129

130130
## Create new user
131131

@@ -160,7 +160,7 @@ API call allowed only for administrator.
160160
}
161161
```
162162

163-
**Example usage:** `Example: Creating a New User`
163+
**Example usage:** `Example: Creating a new user`
164164

165165
## Update user
166166

@@ -195,7 +195,7 @@ API call allowed only for administrator.
195195
}
196196
```
197197

198-
**Example usage:** `Example: Updating an Existing User`, `Example: Adding a User to a Role`
198+
**Example usage:** `Example: Updating an existing user`, `Example: Adding a user to a role`
199199

200200
## Delete user
201201

@@ -206,7 +206,7 @@ API call allowed only for administrator.
206206
Remove internal user.
207207
API call allowed only for administrator.
208208

209-
**Example usage:** `Example: Deleting a User`
209+
**Example usage:** `Example: Deleting a user`
210210

211211
## List RBAC roles
212212

0 commit comments

Comments
 (0)