Skip to content

Commit cb8db69

Browse files
fix(core): remove duplicate titling of help manual (#391)
Resolves #390 Before: <img width="502" alt="Screenshot 2024-09-17 at 2 03 33 PM" src="https://github.com/user-attachments/assets/c1d94fb2-8d17-4b3c-b64e-6c224f7af811"> After: <img width="524" alt="Screenshot 2024-09-17 at 2 02 59 PM" src="https://github.com/user-attachments/assets/3fdb3725-c03f-403b-b4e0-ae5a545898f8"> Co-authored-by: Ryan Schumacher <[email protected]>
1 parent 326e74b commit cb8db69

Some content is hidden

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

49 files changed

+46
-142
lines changed

docs/man/policy/_index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ command:
1212
default: 'false'
1313
---
1414

15-
# Manage platform policy
16-
1715
Policy is a set of rules that are enforced by the platform. Specific to the the data-centric
1816
security, policy revolves around data attributes (referred to as attributes). Within the context
1917
of attributes are namespaces, values, subject-mappings, resource-mappings, key-access-server grants,

docs/man/policy/attributes/_index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,6 @@ command:
77
- attribute
88
---
99

10-
# Manage attributes
11-
1210
Commands to manage attributes within the platform.
1311

1412
Attributes are used to to define the properties of a piece of data. These attributes will then be

docs/man/policy/attributes/create.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Create an attribute
2+
title: Create an attribute definition
33
command:
44
name: create
55
aliases:
@@ -33,8 +33,6 @@ command:
3333
default: ''
3434
---
3535

36-
# Create an attribute definition
37-
3836
Under a namespace, create an attribute with a rule.
3937

4038
### Rules

docs/man/policy/attributes/deactivate.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Deactivate an attribute
2+
title: Deactivate an attribute definition
33
command:
44
name: deactivate
55
flags:
@@ -11,8 +11,6 @@ command:
1111
description: Force deactivation without interactive confirmation (dangerous)
1212
---
1313

14-
# Deactivate an attribute definition
15-
1614
Deactivation preserves uniqueness of the attribute and values underneath within policy and all existing relations,
1715
essentially reserving them.
1816

docs/man/policy/attributes/get.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Get an attribute
2+
title: Get an attribute definition
33
command:
44
name: get
55
aliases:
@@ -10,8 +10,6 @@ command:
1010
description: ID of the attribute
1111
---
1212

13-
# Get an attribute
14-
1513
Retrieve an attribute along with its metadata, rule, and values.
1614

1715
For more general information about attributes, see the `attributes` subcommand.

docs/man/policy/attributes/list.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: List attributes
2+
title: List attribute definitions
33
command:
44
name: list
55
aliases:
@@ -15,8 +15,6 @@ command:
1515
default: active
1616
---
1717

18-
# List the known attributes
19-
2018
By default, the list will only provide `active` attributes if unspecified, but the filter can be controlled with the `--state` flag.
2119

2220
For more general information about attributes, see the `attributes` subcommand.

docs/man/policy/attributes/namespaces/_index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,6 @@ command:
77
- namespace
88
---
99

10-
# Manage attribute namespaces
11-
1210
A namespace is the root (parent) of a set of platform policy. Like an owner or an authority, it fully qualifies attributes and their values,
1311
resource mapping groups, etc. As the various mappings of a platform are to attributes or values, a namespace effectively "owns" the
1412
mappings as well (transitively if not directly).

docs/man/policy/attributes/namespaces/create.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,6 @@ command:
1717
default: ''
1818
---
1919

20-
# Create an attribute namespace
21-
2220
Creation of a `namespace` is required to add attributes or any other policy objects beneath.
2321

2422
For more information, see the `namespaces` subcommand.

docs/man/policy/attributes/namespaces/deactivate.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,6 @@ command:
1111
description: Force deactivation without interactive confirmation (dangerous)
1212
---
1313

14-
# Deactivate an attribute namespace
15-
1614
Deactivating an Attribute Namespace will make the namespace name inactive as well as any attribute definitions and values beneath.
1715

1816
Deactivation of a Namespace renders any existing TDFs of those attributes inaccessible.

docs/man/policy/attributes/namespaces/get.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,4 @@ command:
1010
description: ID of the attribute namespace
1111
---
1212

13-
# Get an attribute namespace
14-
13+
For more information, see the `namespaces` subcommand.

0 commit comments

Comments
 (0)