Skip to content

Commit c9c480e

Browse files
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].
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)*

0 commit comments

Comments
 (0)