Skip to content

Conversation

lidiazuin
Copy link
Contributor

No description provided.

lidiazuin and others added 6 commits August 15, 2025 13:50
…neo4j#2490)

Since we moved them over from DBMS level (while still keeping the DBMS
level syntax, just as another syntax for `DATABASE *`)

---------

Co-authored-by: Mark Dixon <[email protected]>
Co-authored-by: Reneta Popova <[email protected]>
The Operations manual covers all releases of 2025.xx series. That's why
we cannot simply replace examples with new ones, as new functionality
has been added. We also need to retain examples for earlier versions of
Neo4j.
@NataliaIvakina
Copy link
Collaborator

NataliaIvakina commented Aug 28, 2025

On the page Database privileges, Figure 2. Syntax of GRANT and DENY database privileges is not updated.
Is this expected?

@NataliaIvakina
Copy link
Collaborator

NataliaIvakina commented Aug 28, 2025

On the page DBMS privileges, the Figure 1. Syntax of GRANT and DENY DBMS privileges is not updated.
The same question -- is this expected?

Copy link
Collaborator

@NataliaIvakina NataliaIvakina Aug 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think, the branch (on the right hand side) for SERVER MANAGEMENT -> SHOW SERVERS, EXECUTE Privileges, and SHOW SETTINGS privilege is unclear and might be wrong.
There are three equal groups:

  • SERVER MANAGEMENT (with SHOW SERVERS at the 2nd level),
  • EXECUTE PRIVILEGES (that include EXECUTE PROCEDURES, EXECUTE BOOSTED PROCEDURES, EXECUTE ADMIN(ISTRATOR) PROCEDURES, EXECUTE FUNCTIONS, and EXECUTE BOOSTED FUNCTIONS),
  • and SHOW SETTINGS.

I think, we should have three equal branches for them. At the moment, their hierarchy is unclear.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The EXECUTE privileges aren't a group in the hierarchy: they don't have a common parent privilege.

They are included under ALL DBMS PRIVILEGES as that one includes EXECUTE FUNCTION, EXECUTE BOOSTED FUNCTION, EXECUTE PROCEDURE and EXECUTE BOOSTED PROCEDURE for all functions and procedures (which therefore also covers the EXECUTE ADMIN PROCEDURES as that one includes EXECUTE PROCEDURE and EXECUTE BOOSTED PROCEDURE but only for procedures marked as admin procedures). So the old image that currently exist in the documentation is correct to have them just on a line and not in a group, as the 'groups' are actual privileges themselves.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What if to make frames of the first level blocks bold? These blocks are:

  • ROLE MANAGEMENT
  • USER MANAGEMENT
  • IMPERSONATE
  • SERVER MANAGEMENT
  • DATABASE MANAGEMENT
  • ALIAS MANAGEMENT
  • PRIVILEGE MANAGEMENT
  • EXECUTE PRIVILEGES (I think they could be grouped together)
  • SHOW SETTINGS

@@ -76,7 +76,7 @@ For more details on the differences between graphs, databases, and the DBMS, ref

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image::privileges-grant-and-deny-syntax-dbms-privileges.svg[width="800", title="Syntax of GRANT and DENY DBMS privileges"]

@@ -480,7 +480,7 @@ GRANT [IMMUTABLE] TRANSACTION [MANAGEMENT] [( { * \| user[, ...] } )]
|===


image::privileges_grant_and_deny_syntax_database_privileges.svg[title="Syntax of GRANT and DENY Database Privileges"]
image::privileges-grant-and-deny-syntax-database-privileges.svg[title="Syntax of GRANT and DENY Database Privileges", role=popup]
Copy link
Collaborator

@NataliaIvakina NataliaIvakina Aug 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand what is happening here. In line 187, image::privileges_hierarchy_database.svg[title="Database privileges hierarchy"] is used instead of the new file name with hyphens. However, the new image is rendered in the preview.

The file name is updated in the line 483, but the old image is rendered.

Copy link
Contributor

@Hunterness Hunterness Aug 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like the blocks are hard to read and the hierarchy structure is harder to see with this layout :(

(I assume this applies to more than just this one of the hierarchy pictures but I only opened this one so far)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it looks better in the preview than here on github though 🤷

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this doesn't look like the latest version of this image, the development page version (https://development.neo4j.dev/docs/operations-manual/current/authentication-authorization/database-administration/) has some updates (regarding the four ALTER DATABASE privileges) that isn't reflected here

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(nor are they in the hierarchy version)

@neo4j-docops-agent
Copy link
Collaborator

This PR includes documentation updates
View the updated docs at https://neo4j-docs-operations-2541.surge.sh

Updated pages:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants