Skip to content

Commit c9c480e

Browse files
olehermanseolehermanse
committed
Made all titles use sentence case instead of title case
This was inconsistent before, so I am trying to make it consistent. Our preferred style is sentence case, so I am moving towards using using that everywhere. This commit only touches titles (not sub-headings within documents). Ticket: ENT-9964 Signed-off-by: Ole Herman Schumacher Elgesem <[email protected]>
1 parent cfdc0dd commit c9c480e

File tree

178 files changed

+578
-578
lines changed

Some content is hidden

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

178 files changed

+578
-578
lines changed

‎api.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ API uses SQL. With the simplicity of REST and the flexibility of
1616
SQL, users can craft custom reports about systems of arbitrary scale, mining
1717
a wealth of data residing on globally distributed CFEngine Database Servers.
1818

19-
See also the [Enterprise API Examples][Enterprise API Examples] and the [Enterprise API Reference][Enterprise API Reference].
19+
See also the [Enterprise API examples][Enterprise API examples] and the [Enterprise API reference][Enterprise API reference].

‎api/enterprise-api-examples.markdown

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
---
22
layout: default
3-
title: Enterprise API Examples
3+
title: Enterprise API examples
44
published: true
55
sorting: 6
66
tags: [examples, enterprise, REST, API, reporting]
77
---
88

9-
* [Check installation status][Checking Status]
10-
* [Manage users, roles][Managing Users and Roles]
11-
* [Managing Settings][Managing Settings]
12-
* [Browse host information][Browsing Host Information]
13-
* [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
9+
* [Check installation status][Checking status]
10+
* [Manage users, roles][Managing users and roles]
11+
* [Managing settings][Managing settings]
12+
* [Browse host information][Browsing host information]
13+
* [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
1515
* [Tracking changes performed by CFEngine][Tracking changes]
1616

17-
**See also:** [Enterprise API Reference][Enterprise API Reference]
17+
**See also:** [Enterprise API reference][Enterprise API reference]

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
layout: default
3-
title: Browsing Host Information
3+
title: Browsing host information
44
published: true
55
sorting: 50
66
tags: [examples, enterprise, rest, api, reporting, hosts]
77
---
88

99
A resource [/api/host][Host REST API#List hosts] is added as an alternative interface for browsing host
10-
information. For full flexibility we recommend using [SQL][SQL Schema]
10+
information. For full flexibility we recommend using [SQL][SQL schema]
1111
reports via [/api/query][Query REST API#Execute SQL query] for this. however, currently vital signs (data
1212
gathered from `cf-monitord`) is not part of the SQL reports data model.
1313

‎api/enterprise-api-examples/checking-status.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
layout: default
3-
title: Checking Status
3+
title: Checking status
44
published: true
55
sorting: 20
66
tags: [examples, enterprise, rest, api, reporting, status]
77
---
88

9-
You can get basic info about the API by issuing [/api][Status and Settings REST API#Get server status]. This status
9+
You can get basic info about the API by issuing [/api][Status and settings REST API#Get server status]. This status
1010
information may also be useful if you contact support, as it gives some basic
1111
diagnostics.
1212

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: default
3-
title: Managing Settings
3+
title: Managing settings
44
published: true
55
sorting: 30
66
tags: [examples, enterprise, rest, api, reporting, settings, ldap]

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: default
3-
title: Managing Users and Roles
3+
title: Managing users and roles
44
published: true
55
sorting: 40
66
tags: [examples, enterprise, rest, api, reporting, users, roles]

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: default
3-
title: SQL Query Examples
3+
title: SQL query examples
44
published: true
55
tags: [examples, enterprise, rest, api, reporting, sql, queries]
66
---

‎api/enterprise-api-ref.markdown

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: default
3-
title: Enterprise API Reference
3+
title: Enterprise API reference
44
published: true
55
sorting: 70
66
tags: [reference, enterprise, REST, API, reporting, sql]
@@ -11,17 +11,17 @@ number of URI resources that support one or more GET, PUT, POST, or
1111
DELETE operations. While reporting is done using SQL, this query is
1212
always wrapped in a JSON request.
1313

14-
**See also:** [Enterprise API Examples][Enterprise API Examples]
14+
**See also:** [Enterprise API examples][Enterprise API examples]
1515

1616
## Requests
1717

1818
**GET** requests are one of **listing** or **getting**. **Listing** resources
1919
means that a number of results will be returned, but each entry may contain
20-
limited information. An example of a **listing** query is [/api/user][Users and Access-Control REST API#List users] to list
20+
limited information. An example of a **listing** query is [/api/user][Users and access-control REST API#List users] to list
2121
users. Notice that URI components are always non-plural. An exception to this
22-
is [/api/settings][Status and Settings REST API#Get settings], which returns the singleton resource for settings.
22+
is [/api/settings][Status and settings REST API#Get settings], which returns the singleton resource for settings.
2323
**Getting** a resource specifies an individual resource to return, e.g.
24-
[/api/user/homer][Users and Access-Control REST API#Get user data].
24+
[/api/user/homer][Users and access-control REST API#Get user data].
2525

2626
**PUT** request typically create a new resource, e.g. a user.
2727

@@ -86,9 +86,9 @@ All timestamps are reported in *Unix Time*, i.e. seconds since 1970.
8686
The API supports both internal and external authentication. The internal users
8787
table will always be consulted first, followed by an external source specified
8888
in the settings. External sources are *OpenLDAP* or *Active Directory* servers
89-
configurable through [/api/settings][Status and Settings REST API#Update settings].
89+
configurable through [/api/settings][Status and settings REST API#Update settings].
9090

9191

9292
## Authorization
9393

94-
Some resources require that the request user is a member of the *admin* role. Roles are managed with [/api/role][Users and Access-Control REST API#List RBAC roles]. Role Based Access Control (RBAC) is configurable through the settings. Users typically have permission to access their own resources, e.g. their own scheduled reports.
94+
Some resources require that the request user is a member of the *admin* role. Roles are managed with [/api/role][Users and access-control REST API#List RBAC roles]. Role Based Access Control (RBAC) is configurable through the settings. Users typically have permission to access their own resources, e.g. their own scheduled reports.

‎api/enterprise-api-ref/changes.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ List changes performed by CFEngine to the infrastructure. List can be narrowed d
162162
* **data.hostkey**
163163
Unique host identifier.
164164
* **data.hostname**
165-
Host name locally detected on the host, configurable as `hostIdentifier` option in [Settings API][Status and Settings REST API#Get settings] and Mission Portal settings UI.
165+
Host name locally detected on the host, configurable as `hostIdentifier` option in [Settings API][Status and settings REST API#Get settings] and Mission Portal settings UI.
166166
* **data.logmessages**
167167
List of 5 last messages generated during promise execution. Log messages can be used for tracking specific changes made by CFEngine while repairing or failing promise execution.
168168
* **data.policyfile**
@@ -174,7 +174,7 @@ List changes performed by CFEngine to the infrastructure. List can be narrowed d
174174
* **data.promiser**
175175
Object affected by a promise.
176176
* **data.promisetype**
177-
[Type][Promise Types] of the promise.
177+
[Type][Promise types] of the promise.
178178
* **data.stackpath**
179179
Call stack of the promise.
180180

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
layout: default
3-
title: Import & Export API
3+
title: Import & export API
44
published: true
55
tags: [reference, enterprise, API, import, export]
66
---
77

8-
Import & Export API provides users the ability to transfer Mission Portal data between hubs.
8+
Import & export API provides users the ability to transfer Mission Portal data between hubs.
99

1010
**See also:** [Export/Import Settings UI][Settings#Export/Import]
1111

@@ -91,7 +91,7 @@ HTTP 200 Ok
9191

9292
* **item_id** *(array)*
9393
Item id to be exported.
94-
List of item ids you can obtain through [List of items to export][Import & Export API#Get available items to export]
94+
List of item ids you can obtain through [List of items to export][Import & export API#Get available items to export]
9595
call described below.
9696

9797
* **encryptionKey** *(string)*

‎api/enterprise-api-ref/export-import-compliance-report-api.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: default
3-
title: Import & Export Compliance Report API
3+
title: Import & export compliance report API
44
published: true
55
tags: [reference, enterprise, API, import, export, compliance report]
66
---

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

Lines changed: 3 additions & 3 deletions
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,7 +157,7 @@ HTTP 202 ACCEPTED
157157
HTTP 202 ACCEPTED
158158
```
159159

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

162162
## Enable hub as a Superhub
163163

@@ -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/file-changes.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: default
3-
title: File Changes API
3+
title: File changes API
44
published: true
55
tags: [reference, enterprise, API, reporting, file changes]
66
---

‎api/enterprise-api-ref/host.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Host API allows to access host specific information.
6060
* **id**
6161
Unique host identifier.
6262
* **hostname**
63-
Host name. Can be reconfigured globally to represent variable set in the policy using **hostIdentifier** [setting][Status and Settings REST API#Update settings].
63+
Host name. Can be reconfigured globally to represent variable set in the policy using **hostIdentifier** [setting][Status and settings REST API#Update settings].
6464
* **ip**
6565
IP address of the host. If host have multiple network interfaces, IP belongs to the interface that is used to communicate with policy server.
6666
* **lastreport**
@@ -103,7 +103,7 @@ Host API allows to access host specific information.
103103
* **id**
104104
Unique host identifier.
105105
* **hostname**
106-
Host name. Can be reconfigured globally to represent variable set in the policy using **hostIdentifier** [setting][Status and Settings REST API#Update settings].
106+
Host name. Can be reconfigured globally to represent variable set in the policy using **hostIdentifier** [setting][Status and settings REST API#Update settings].
107107
* **ip**
108108
IP address of the host. If host have multiple network interfaces, IP belongs to the interface that is used to communicate with policy server.
109109
* **lastreport**
@@ -139,7 +139,7 @@ The hostkey is then removed from:
139139

140140
Note: There is a record of the host retained that includes the time when the host was deleted and this record also prevents further collection from this host identity.
141141

142-
**See also:** [Example removing host data][Browsing Host Information#example: removing host data]
142+
**See also:** [Example removing host data][Browsing host information#example: removing host data]
143143

144144
## Hosts list grouped by hard classes
145145

‎api/enterprise-api-ref/inventory.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ curl -k --user <username>:<password> \
188188
Shows list of all inventory attributes available in the system.
189189
190190
See more details:
191-
* [Custom Inventory][Custom Inventory]
191+
* [Custom inventory][Custom inventory]
192192
193193
**CURL request example**
194194
```

‎api/enterprise-api-ref/query.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ tags: [reference, enterprise, REST, API, SQL, reporting, URI]
77

88
In case of a need for full flexibility, Query API allow users to execute SQL queries on CFEngine Database.
99

10-
Database schema available can be found [here][SQL Schema].
10+
Database schema available can be found [here][SQL schema].
1111

1212
## Execute SQL query
1313

‎api/enterprise-api-ref/sql-schema.markdown

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: default
3-
title: SQL Schema
3+
title: SQL schema
44
published: true
55
tags: [reference, enterprise, REST, API, reporting, sql, schema]
66
---
@@ -132,7 +132,7 @@ CFEngine contexts present on hosts at their last reported cf-agent execution.
132132
Unique host identifier. All tables can be joined by `HostKey` to connect data concerning same hosts.
133133

134134
* **ContextName** *(text)*
135-
CFEngine [context][Classes and Decisions] set by cf-agent.
135+
CFEngine [context][Classes and decisions] set by cf-agent.
136136

137137
* **MetaTags** *(text[])*
138138
List of [meta tags][Tags for variables, classes, and bundles] set for the context.
@@ -192,7 +192,7 @@ CFEngine contexts set on hosts by CFEngine over period of time.
192192
* `UNTRACKED` - CFEngine provides a mechanism for filtering unwanted data from being reported. `UNTRACKED` marker states that information about this context is being filtered and will not report any future information about it.
193193

194194
* **ContextName** *(text)*
195-
CFEngine [context][Classes and Decisions] set by cf-agent.
195+
CFEngine [context][Classes and decisions] set by cf-agent.
196196

197197
* **MetaTags** *(text[])*
198198
List of [meta tags][Tags for variables, classes, and bundles] set for the context.
@@ -309,7 +309,7 @@ Hosts table contains basic information about hosts managed by CFEngine.
309309

310310
* **HostName** *(text)*
311311
Host name locally detected on the host, configurable as `hostIdentifier`
312-
option in [Settings API][Status and Settings REST API#Get settings] and
312+
option in [Settings API][Status and settings REST API#Get settings] and
313313
Mission Portal settings UI.
314314

315315
* **IPAddress** *(text)*
@@ -779,7 +779,7 @@ Promises executed on hosts during their last reported cf-agent run.
779779
[Bundle][Bundles] name where the promise is executed.
780780

781781
* **PromiseType** *(text)*
782-
[Type][Promise Types] of the promise.
782+
[Type][Promise types] of the promise.
783783

784784
* **Promiser** *(text)*
785785
Object affected by a promise.
@@ -914,7 +914,7 @@ Promise status / outcome changes over period of time.
914914
[Bundle][Bundles] name where the promise is executed.
915915

916916
* **PromiseType** *(text)*
917-
[Type][Promise Types] of the promise.
917+
[Type][Promise types] of the promise.
918918

919919
* **Promiser** *(text)*
920920
Object affected by a promise.
@@ -1049,7 +1049,7 @@ History of promises executed on hosts.
10491049
[Bundle][Bundles] name where the promise is executed.
10501050

10511051
* **PromiseType** *(text)*
1052-
[Type][Promise Types] of the promise.
1052+
[Type][Promise types] of the promise.
10531053

10541054
* **Promiser** *(text)*
10551055
Object affected by a promise.
@@ -1732,7 +1732,7 @@ In this table data are cached what gives a better query performance
17321732

17331733
* **HostName** *(text)*
17341734
Host name locally detected on the host, configurable as `hostIdentifier`
1735-
option in [Settings API][Status and Settings REST API#Get settings] and
1735+
option in [Settings API][Status and settings REST API#Get settings] and
17361736
Mission Portal settings UI.
17371737

17381738
* **IPAddress** *(text)*

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: default
3-
title: Status and Settings REST API
3+
title: Status and settings REST API
44
published: true
55
tags: [reference, enterprise, REST, API, reporting, status, URI, ldap, settings]
66
---
@@ -66,7 +66,7 @@ REST API for managing settings, checking hub status.
6666
* **license.licenseType**
6767
License description.
6868

69-
**Example usage:** `Checking Status`
69+
**Example usage:** `Checking status`
7070

7171
## Get settings
7272

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: default
3-
title: Users and Access-Control REST API
3+
title: Users and access-control REST API
44
published: true
55
tags: [reference, enterprise, REST, API, reporting, URI, users, rbac]
66
---

‎cheatsheet.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -373,7 +373,7 @@ SELECT
373373
+++ b/README.md
374374
@@ -377,8 +377,12 @@ As a general note, avoiding abbreviations provides better readability.
375375

376-
* follow the [Policy Style Guide](guide/writing-and-serving-policy/policy-style.markdown)
376+
* follow the [Policy style guide](guide/writing-and-serving-policy/policy-style.markdown)
377377
in examples and code snippets
378378
-* always run it through Pygments plus the appropriate lexer (only cf3
379379
- supported for now)
@@ -394,7 +394,7 @@ index 92555a2..b49c0bb 100644
394394
+++ b/README.md
395395
@@ -377,8 +377,12 @@ As a general note, avoiding abbreviations provides better readability.
396396

397-
* follow the [Policy Style Guide](guide/writing-and-serving-policy/policy-style.markdown)
397+
* follow the [Policy style guide](guide/writing-and-serving-policy/policy-style.markdown)
398398
in examples and code snippets
399399
-* always run it through Pygments plus the appropriate lexer (only cf3
400400
- supported for now)

‎enterprise-cfengine-guide/install-get-started.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ https://docs.google.com/document/d/1CeRR8cuMtrrr0X27gzVzP2ndiU0HuHvo7dJT2vIWfp0/
1616

1717
## Installation ##
1818

19-
The [General Installation][General Installation] instructions provide the detailed steps for installing CFEngine, which are generally the same steps to follow for CFEngine Enterprise, with the exception of license keys (if applicable), and also some aspects of post-installation and configuration.
19+
The [General installation][General installation] instructions provide the detailed steps for installing CFEngine, which are generally the same steps to follow for CFEngine Enterprise, with the exception of license keys (if applicable), and also some aspects of post-installation and configuration.
2020

2121
### Installing Enterprise Licenses ###
2222

@@ -36,7 +36,7 @@ The default FROM email for all emails sent from the Mission Portal is ```admin@o
3636

3737
Consider enabling the built-in version control of your policies as
3838
described in
39-
[Version Control and Configuration Policy][Best Practices#Version Control and Configuration Policy]
39+
[Version control and Configuration Policy][Best practices#Version control and Configuration Policy]
4040

4141
Whether you do or not, please put your policies in some kind of
4242
backed-up VCS. Losing work because of "fat fingering" `rm` commands is

0 commit comments

Comments
 (0)