Skip to content

Commit 2fc79d7

Browse files
committed
Merge branch 'dev' into main-broken-links
2 parents f708839 + 78224e0 commit 2fc79d7

File tree

102 files changed

+347
-298
lines changed

Some content is hidden

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

102 files changed

+347
-298
lines changed

.backportrc.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"repoOwner": "Neo4j",
3+
"repoName": "docs-operations",
4+
"prTitle": "[Cherry-pick][{{targetBranch}}] {{commitMessages}}"
5+
}
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: auto-cherry-pick
2+
on:
3+
pull_request_target:
4+
types: ["closed"]
5+
6+
jobs:
7+
backport:
8+
name: Cherry-pick PR
9+
runs-on: [ubuntu-latest]
10+
if: |
11+
github.event.pull_request.merged == true
12+
&& contains(github.event.pull_request.labels.*.name, 'auto-cherry-pick')
13+
&& github.event.action == 'closed'
14+
steps:
15+
- name: Cherry-pick action
16+
uses: sorenlouv/backport-github-action@929f69d04adbc196d982e60f02837b6cc00b3129
17+
with:
18+
github_token: ${{ secrets.DOCS_AUTO_CP_TOKEN }}
19+
auto_backport_label_prefix: auto-cherry-pick-to-
20+
add_original_reviewers: false
21+
22+
- name: Info log
23+
if: ${{ success() }}
24+
run: cat ~/.backport/backport.info.log
25+
26+
- name: Debug log
27+
if: ${{ failure() }}
28+
run: cat ~/.backport/backport.debug.log
29+
30+

README.adoc

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,34 @@ When you run `npm start`, the project is monitored for updates to asciidoc files
3535

3636
If a change to an asciidoc file is detected the site is automatically rebuilt.
3737

38+
== Enable automatic cherry-picking on a PR
39+
40+
To enable automatic cherry-picking on a PR, add the label `auto-cherry-pick` to it.
41+
Without it, the responsible GitHub action is not going to be triggered.
42+
43+
To select the target branches you would like to cherry-pick your PR to, add labels of the following structure: `auto-cherry-pick-to-<targetBranch>`.
44+
For example: `auto-cherry-pick-to-main` to cherry-pick it to the branch `main` or `auto-cherry-pick-to-5.x` for the branch `5.x`.
45+
You may even add new labels for branches that do not have such a label yet.
46+
47+
The feature is triggered by either merging a PR with the `auto-cherry-pick` label or by adding the `auto-cherry-pick` label to an already closed and merged PR.
48+
In the latter case, ensure that you first add the labels containing the target branches and then finally the `auto-cherry-pick` label.
49+
Otherwise the automation starts without any target branches.
50+
51+
=== Details
52+
53+
The PRs created by this GitHub action will have their heading prefixed with `[Cherry-pick][<targetBranch>]`.
54+
So, for example, for `main` as the target branch and `some changes` as the original PR heading, it results in `[Cherry-pick][main] some changes` as the heading for the cherry-picked PR.
55+
In case an assignee was set for the original PR, the cherry-picked PRs will also receive the same assignee.
56+
You must add reviewers manually after the cherry-picked PRs have been created.
57+
58+
The creation of cherry-picked PRs can take a few minutes.
59+
If you are an assignee of the original PR, you receive an email notification once the cherry-picked PRs have been created.
60+
The original PR is updated with a comment that contains links to the newly created cherry-picked PRs.
61+
62+
In case of a merge conflict while cherry-picking to a specific release branch, the branch will be skipped.
63+
Information on skipped branches is also included in the comment added to the original PR.
64+
In that case you have to take care of cherry-picking manually and resolve the conflicts.
65+
This is not going to influence the other release branches as long as they do not have conflicts.
66+
67+
68+

models/hospital/access-control-old.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
When creating a database, administrators may want to establish which users have the ability to access certain information.
77

8-
As described in xref:authentication-authorization/built-in-roles/auth-built-in-roles[Built-in roles], Neo4j already offers preset roles configured to specific permissions (i.e. read, edit, or write).
8+
As described in xref:authentication-authorization/built-in-roles.adoc[Built-in roles], Neo4j already offers preset roles configured to specific permissions (i.e. read, edit, or write).
99
While these built-in roles cover many common daily scenarios, it is also possible to create custom roles for specific needs.
1010

1111
This page contains an example that illustrates various aspects of security and fine-grained access control.
@@ -85,7 +85,7 @@ This allows users to be created entirely within the database security model, a s
8585
For more information, see link:{neo4j-docs-base-uri}/cypher-manual/current/access-control/[Cypher Manual -> Access control].
8686

8787
The following examples show two different approaches to using Neo4j security features to support the _healthcare_ database application.
88-
The first approach uses xref:authentication-authorization/built-in-roles/auth-built-in-roles[Built-in roles], whereas the second uses more advanced resources with fine-grained privileges for <<auth-access-control-using-privileges, sub-graph access control>>.
88+
The first approach uses xref:authentication-authorization/built-in-roles.adoc[Built-in roles], whereas the second uses more advanced resources with fine-grained privileges for <<auth-access-control-using-privileges, sub-graph access control>>.
8989

9090
In this example, consider five users of the _healthcare_ database:
9191

modules/ROOT/pages/authentication-authorization/built-in-roles.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -827,7 +827,7 @@ These include the rights to perform the following classes of tasks:
827827

828828
* Manage xref:authentication-authorization/database-administration.adoc[database privileges] to control the rights to perform actions on specific databases:
829829
** Manage access to a database and the right to start and stop a database.
830-
** Manage link:{neo4j-docs-base-uri}/cypher-manual/current/indexes-for-search-performance/[indexes] and link:{neo4j-docs-base-uri}/cypher-manual/current/constraints/[constraints].
830+
** Manage link:{neo4j-docs-base-uri}/cypher-manual/current/indexes/search-performance-indexes/overview/[indexes] and link:{neo4j-docs-base-uri}/cypher-manual/current/constraints/[constraints].
831831
** Allow the creation of labels, relationship types, or property names.
832832
** Manage transactions.
833833
* Manage xref:authentication-authorization/dbms-administration.adoc[DBMS privileges] to control the rights to perform actions on the entire system:

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ CREATE ROLE serverViewer IF NOT EXISTS;
7272

7373
All DBMS privileges are relevant system-wide.
7474
Like user management, they do not belong to one specific database or graph.
75-
For more details on the differences between graphs, databases, and the DBMS, refer to link:{neo4j-docs-base-uri}/cypher-manual/current/introduction/cypher_neo4j/[Cypher Manual -> Cypher and Neo4j].
75+
For more details on the differences between graphs, databases, and the DBMS, refer to link:{neo4j-docs-base-uri}/cypher-manual/current/introduction/cypher-neo4j/[Cypher Manual -> Cypher and Neo4j].
7676

7777
image::privileges_grant_and_deny_syntax_dbms_privileges.svg[width="800", title="Syntax of GRANT and DENY DBMS privileges"]
7878

modules/ROOT/pages/authentication-authorization/index.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ For more information, see xref:authentication-authorization/password-and-user-re
2828
When triggered, Neo4j logs an error containing a timestamp and the message `failed to log in: too many failed attempts` in the _security.log_.
2929
====
3030
+
31-
For the relevant Cypher commands, see xref:authentication-authorization/manage-users.adoc#access-control-user-syntax[Manage users syntax], xref:authentication-authorization/manage-roles.adoc#access-control-role-syntax[Manage roles syntax], and xref:authentication-authorization/manage-privileges.adoc#access-control-privileges-syntax[Manage privileges syntax].
31+
For the relevant Cypher commands, see xref:authentication-authorization/manage-users.adoc#access-control-user-syntax[Manage users syntax], xref:authentication-authorization/manage-roles.adoc#access-control-role-syntax[Manage roles syntax], and xref:authentication-authorization/manage-privileges.adoc[Manage privileges syntax].
3232
Various scenarios that illustrate the use of the native auth provider are available in xref:tutorial/access-control.adoc[].
3333

3434
*User auth providers*::
@@ -47,7 +47,7 @@ The configuration steps are described in xref:authentication-authorization/sso-i
4747
*Custom-built plugin auth providers*::
4848
A plugin option for building custom integrations.
4949
It is recommended that this option is used as part of a custom delivery as negotiated with link:https://neo4j.com/professional-services/[Neo4j Professional Services].
50-
For more information, see link:{neo4j-docs-base-uri}/java-reference/{page-version}/extending-neo4j/security-plugins#extending-neo4j-security-plugins[Java Reference -> Authentication and authorization plugins].
50+
For more information, see link:{neo4j-docs-base-uri}/java-reference/{page-version}/extending-neo4j/security-plugins[Java Reference -> Authentication and authorization plugins].
5151

5252
*Kerberos authentication and single sign-on*::
5353
In addition to LDAP, native, and custom providers, Neo4j supports Kerberos for authentication and single sign-on.

modules/ROOT/pages/authentication-authorization/ldap-integration.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ this LDAP group will fail authentication, even if their credentials are correct.
6565
|===
6666

6767
All settings are defined at server startup time in the default configuration file _xref:configuration/neo4j-conf.adoc[neo4j.conf]_ or can be modified at
68-
runtime using xref:procedures.adoc#procedure_dbms_setconfigvalue[`dbms.setConfigValue()`].
68+
runtime using xref:procedures.adoc#procedure_dbms_setConfigValue[`dbms.setConfigValue()`].
6969

7070

7171
[[auth-ldap-configure-provider]]
@@ -470,7 +470,7 @@ SET AUTH 'ldap' { SET ID 'cn=alice,ou=sales,dc=example,dc=com' }
470470
You can verify that your LDAP configuration is correct, and that the LDAP server responds, by using the LDAP command-line tool `ldapsearch`.
471471

472472
The `ldapsearch` command accepts the LDAP configuration setting values as input and verifies both the authentication (using the `simple` mechanism) and authorization of a user.
473-
See the https://docs.ldap.com/ldap-sdk/docs/tool-usages/ldapsearch.html[ldapsearch official documentation^] for more advanced usage and how to use SASL authentication mechanisms.
473+
See the link:https://docs.ldap.com/ldap-sdk/docs/tool-usages/ldapsearch.html[ldapsearch official documentation] for more advanced usage and how to use SASL authentication mechanisms.
474474

475475
. Verify the authentication and authorization of a user.
476476
For example, `john`.

modules/ROOT/pages/authentication-authorization/limitations.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@ The known limitations and implications of Neo4j's role-based access control secu
1919
[[access-control-limitations-indexes]]
2020
== Security and indexes
2121

22-
As described in link:{neo4j-docs-base-uri}/cypher-manual/current/indexes-for-search-performance/[Cypher Manual -> Indexes for search performance], Neo4j {neo4j-version} supports the creation and use of indexes to improve the performance of Cypher queries.
22+
As described in link:{neo4j-docs-base-uri}/cypher-manual/current/indexes/search-performance-indexes/overview/[Cypher Manual -> Indexes for search performance], Neo4j {neo4j-version} supports the creation and use of indexes to improve the performance of Cypher queries.
2323

2424
Note that the Neo4j security model impacts the results of queries, regardless if the indexes are used or not.
2525
When using non full-text Neo4j indexes, a Cypher query will always return the same results it would have if no index existed.
2626
This means that, if the security model causes fewer results to be returned due to restricted read access in xref:authentication-authorization/manage-privileges.adoc[Graph and sub-graph access control],
2727
the index will also return the same fewer results.
2828

29-
However, this rule is not fully obeyed by link:{neo4j-docs-base-uri}/cypher-manual/current/indexes-for-full-text-search[Cypher Manual -> Indexes for full-text search].
29+
However, this rule is not fully obeyed by link:{neo4j-docs-base-uri}/cypher-manual/current/indexes/semantic-indexes/full-text-indexes/[Cypher Manual -> Indexes for full-text search].
3030
These specific indexes are backed by _Lucene_ internally.
3131
It is therefore not possible to know for certain whether a security violation has affected each specific entry returned from the index.
3232
In face of this, Neo4j will return zero results from full-text indexes in case it is determined that any result might be violating the security privileges active for that query.
@@ -51,7 +51,7 @@ CREATE FULLTEXT INDEX userNames FOR (n:User|Person) ON EACH [n.name, n.surname];
5151
[NOTE]
5252
====
5353
Full-text indexes support multiple labels.
54-
See link:{neo4j-docs-base-uri}/cypher-manual/current/indexes-for-full-text-search/[Cypher Manual -> Indexes for full-text search] for more details on creating and using full-text indexes.
54+
See link:{neo4j-docs-base-uri}/cypher-manual/current/indexes/semantic-indexes/full-text-indexes//[Cypher Manual -> Indexes for full-text search] for more details on creating and using full-text indexes.
5555
====
5656

5757
After creating these indexes, it would appear that the latter two indexes accomplish the same thing.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ CREATE ROLE roleLoadCidr
1414
This section explains how to use Cypher to manage load privileges.
1515
All load privileges apply to the whole system.
1616
Like DBMS privileges, they do not belong to one specific database or graph.
17-
For more details on the differences between graphs, databases, and the DBMS, refer to link:{neo4j-docs-base-uri}/cypher-manual/current/introduction/cypher_neo4j/[Cypher Manual -> Cypher and Neo4j].
17+
For more details on the differences between graphs, databases, and the DBMS, refer to link:{neo4j-docs-base-uri}/cypher-manual/current/introduction/cypher-neo4j/[Cypher Manual -> Cypher and Neo4j].
1818

1919
image::privileges_grant_and_deny_syntax_load_privileges.svg[width="800", title="Syntax of GRANT and DENY load Privileges"]
2020

0 commit comments

Comments
 (0)