Skip to content

Commit ab29771

Browse files
Replace labels with roles (#1473) (#1476)
Using the new `role=label--` notation for roles/labels on headings and block elements. Cherry-picked from #1473 Co-authored-by: Neil Dewhurst <[email protected]>
1 parent b1adb6f commit ab29771

21 files changed

+906
-289
lines changed

modules/ROOT/pages/authentication-authorization/dbms-administration.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1913,11 +1913,10 @@ a|Rows: 2
19131913
======
19141914

19151915

1916+
[role=label--new-5.6]
19161917
[[access-control-dbms-administration-setting]]
19171918
== The DBMS `SETTING` privileges
19181919

1919-
_This feature was introduced in Neo4j 5.6._
1920-
19211920
The ability to show configuration settings can be granted via the `SHOW SETTING` privilege.
19221921
A role with this privilege is allowed to query the configuration settings matched by the <<access-control-name-globbing, name-globbing>>.
19231922

modules/ROOT/pages/authentication-authorization/manage-privileges.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -195,11 +195,11 @@ The following image shows the hierarchy between different graph privileges:
195195

196196
image::privileges_hierarchy.svg[title="Graph privileges hierarchy"]
197197

198+
199+
[role=label--new-5.9]
198200
[[access-control-list-supported-privileges]]
199201
== Listing supported privileges
200202

201-
_This feature was introduced in Neo4j 5.9._
202-
203203
Supported privileges can be displayed using the `SHOW SUPPORTED PRIVILEGES` command.
204204
This lists the privileges that are possible to grant or deny on a server, together with the structure of the privilege.
205205

modules/ROOT/pages/authentication-authorization/manage-users.adoc

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,15 @@ When connected to the DBMS over `bolt`, administration commands are automaticall
1010

1111
There are two types of user states in the `system` database:
1212

13-
* `ACTIVE` state (default for new users):
13+
`ACTIVE` state:: (default for new users)
1414
Users can log into Neo4j and perform queries according to their privileges.
1515

16-
* `SUSPENDED` state label:enterprise-edition[]:
17-
** Native users who authenticate and authorize against the system graph cannot log into Neo4j.
16+
// [role=label--enterprise-edition]
17+
`SUSPENDED` state label:enterprise-edition[]::
18+
19+
* Native users who authenticate and authorize against the system graph cannot log into Neo4j.
1820
If suspended while using Neo4j, they lose all assigned roles with their privileges, including the `PUBLIC` role, until reactivated.
19-
** Users who authenticate and authorize against an external ID provider (e.g., LDAP) can still log in.
21+
* Users who authenticate and authorize against an external ID provider (e.g., LDAP) can still log in.
2022
If suspended while using Neo4j, they retain the roles and the privileges assigned by the external provider, including the `PUBLIC` role.
2123
To prevent any of these, you need to use the mechanisms of their identity provider.
2224

@@ -341,9 +343,9 @@ GRANT DROP USER
341343
|===
342344

343345

344-
[NOTE]
346+
[NOTE,role=label--enterprise-edition]
345347
====
346-
The `SHOW USER[S] PRIVILEGES` command is only available in Neo4j Enterprise Edition. label:enterprise-edition[]
348+
The `SHOW USER[S] PRIVILEGES` command is only available in Neo4j Enterprise Edition.
347349
====
348350

349351

@@ -622,9 +624,9 @@ SET STATUS ACTIVE
622624
623625
======
624626

625-
[NOTE]
627+
[NOTE, role=label--enterprise-edition]
626628
====
627-
The `SET STATUS {ACTIVE | SUSPENDED}` and `SET HOME DATABASE` parts of the commands are only available in Neo4j Enterprise Edition. label:enterprise-edition[]
629+
The `SET STATUS {ACTIVE | SUSPENDED}` and `SET HOME DATABASE` parts of the commands are only available in Neo4j Enterprise Edition.
628630
====
629631

630632
The `CREATE USER` command is optionally idempotent, with the default behavior to throw an exception if the user already exists.
@@ -775,9 +777,9 @@ When altering a user, it is only necessary to specify the changes required.
775777
For example, leaving out the `CHANGE [NOT] REQUIRED` part of the query will leave that unchanged.
776778
====
777779

778-
[NOTE]
780+
[NOTE, role=label--enterprise-edition]
779781
====
780-
The `SET STATUS {ACTIVE | SUSPENDED}`, `SET HOME DATABASE`, and `REMOVE HOME DATABASE` parts of the command are only available in Neo4j Enterprise Edition. label:enterprise-edition[]
782+
The `SET STATUS {ACTIVE | SUSPENDED}`, `SET HOME DATABASE`, and `REMOVE HOME DATABASE` parts of the command are only available in Neo4j Enterprise Edition.
781783
====
782784

783785
The changes to the user will appear on the list provided by `SHOW USERS`:

modules/ROOT/pages/authentication-authorization/password-and-user-recovery.adoc

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -109,9 +109,9 @@ Alternatively, log into Neo4j Browser.
109109
$ bin/cypher-shell -d system
110110
----
111111
+
112-
[NOTE]
112+
[NOTE, role=label--cluster]
113113
====
114-
label:Cluster[] If you have specified a non-default port for your `bolt` connector, add `-a neo4j://<your-cluster-member>:<non-default-bolt-port>` to the `cypher-shell` command to be able to connect to your cluster member.
114+
If you have specified a non-default port for your `bolt` connector, add `-a neo4j://<your-cluster-member>:<non-default-bolt-port>` to the `cypher-shell` command to be able to connect to your cluster member.
115115
====
116116
. Set a new password for the admin user.
117117
In this example, the admin user is named `neo4j`.
@@ -147,9 +147,9 @@ Alternatively, log into Neo4j Browser.
147147
$ bin/cypher-shell -d system
148148
----
149149
+
150-
[NOTE]
150+
[NOTE, role=label--cluster]
151151
====
152-
label:Cluster[] If you have specified a non-default port for your `bolt` connector, add `-a neo4j://<your-cluster-member>:<non-default-bolt-port>` to the `cypher-shell` command to be able to connect to your cluster member.
152+
If you have specified a non-default port for your `bolt` connector, add `-a neo4j://<your-cluster-member>:<non-default-bolt-port>` to the `cypher-shell` command to be able to connect to your cluster member.
153153
====
154154
. Grant the admin user role to an existing user.
155155
In this example, the user is named `neo4j`.
@@ -185,9 +185,10 @@ Alternatively, log into Neo4j Browser.
185185
$ bin/cypher-shell -d system
186186
----
187187
+
188+
[role=label--cluster]
188189
[NOTE]
189190
====
190-
label:Cluster[] If you have specified a non-default port for your `bolt` connector, add `-a neo4j://<your-cluster-member>:<non-default-bolt-port>` to the `cypher-shell` command to be able to connect to your cluster member.
191+
If you have specified a non-default port for your `bolt` connector, add `-a neo4j://<your-cluster-member>:<non-default-bolt-port>` to the `cypher-shell` command to be able to connect to your cluster member.
191192
====
192193
. Recreate the admin role with its original capabilities.
193194
+

modules/ROOT/pages/cloud-deployments/neo4j-aws.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,13 +126,17 @@ After the installation finishes successfully, the CloudFormation template provid
126126

127127
|===
128128

129+
129130
== Cluster version consistency
130131

131132
When the CloudFormation template creates a new Neo4j cluster, an Auto Scaling group (ASG) is created and tagged with the minor version of the installed Neo4j database.
132133
If you add more EC2 instances to your ASG, they will be installed with the same minor version, ensuring that all Neo4j cluster servers are installed with the same version, regardless of when the EC2 instances were created.
133134

135+
136+
[role=label--enterprise-edition]
134137
== Licensing
135-
label:Enterprise[]
138+
139+
// label:Enterprise[]
136140

137141
Installing and starting Neo4j from the AWS marketplace constitutes an acceptance of the Neo4j license agreement.
138142
When deploying Neo4j, users are required to confirm that they either have an enterprise license or accept the terms of the Neo4j evaluation license.

modules/ROOT/pages/cloud-deployments/neo4j-azure.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,8 +125,11 @@ If the validation fails, it might be because you have chosen VMs that are too la
125125
When the ARM template creates a new Neo4j cluster, a Virtual Machine Scale Set (VMSS) is created and tagged with the minor version of the installed Neo4j database.
126126
If you add more VM instances to your VMSS, they will be installed using the same minor version, ensuring that all Neo4j cluster servers are installed with the same version, regardless of when the VM instances were created.
127127

128+
129+
[role=label--enterprise-edition]
128130
== Licensing
129-
label:Enterprise[]
131+
132+
// label:Enterprise[]
130133

131134
Installing and starting Neo4j from the Azure marketplace constitutes an acceptance of the Neo4j license agreement.
132135
When deploying Neo4j, users are required to confirm that they either have an enterprise license.

modules/ROOT/pages/cloud-deployments/neo4j-gcp.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,8 +118,11 @@ After the installation finishes successfully, the Deployment Manager template pr
118118
The Neo4j Browser can be easily launched in a new window by clicking the button entitled *Log into the Neo4j Browser*.
119119
====
120120

121+
122+
[role=label--enterprise-edition]
121123
== Licensing
122-
label:Enterprise[]
124+
125+
// label:Enterprise[]
123126

124127
Installing and starting Neo4j from the GCP marketplace constitutes an acceptance of the Neo4j license agreement.
125128
When deploying Neo4j, you are required to confirm that you either have an Enterprise license or accept the terms of the Neo4j evaluation license.

modules/ROOT/pages/clustering/servers.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,8 @@ When a server is no longer needed, it cannot be removed from the cluster while i
8585
The command `DEALLOCATE DATABASE[S] FROM SERVER[S] _server_[,...]` is used to transition servers to the _Deallocating_ state, reallocating all their hosted databases to other servers in the cluster.
8686
Additionally, servers which are deallocating will not have any further databases allocated to them.
8787

88-
=== Deallocated state label:new[Introduced in 5.15]
88+
[role=label--new-5.15]
89+
=== Deallocated state
8990

9091
When a server is in the deallocated state it no longer hosts any databases any databases besides system and can be removed from the cluster.
9192
Additionally, deallocated servers cannot have any further databases allocated to them.

0 commit comments

Comments
 (0)