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

Like user management, they do not belong to one specific database or graph.
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].

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"]



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

@Hunterness Hunterness Sep 1, 2025

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
Collaborator

@renetapopova renetapopova left a comment

Choose a reason for hiding this comment

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

Thank you, @lidiazuin. They all look good from a visual perspective but I've found some inconsistencies and things that might lead to misunderstandings.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Alter database is missing
Screenshot 2025-09-08 at 13 04 42

Copy link
Contributor

Choose a reason for hiding this comment

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

#2541 (comment) I also noticed this :P

Copy link
Collaborator

Choose a reason for hiding this comment

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

Screenshot 2025-09-08 at 13 17 15

Copy link
Collaborator

@renetapopova renetapopova Sep 8, 2025

Choose a reason for hiding this comment

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

Screenshot 2025-09-08 at 13 19 37

Copy link
Contributor

Choose a reason for hiding this comment

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

image I think some of your image comments doesn't load?

Copy link
Collaborator

@renetapopova renetapopova Sep 8, 2025

Choose a reason for hiding this comment

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

Screenshot 2025-09-08 at 13 31 37

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The connections that you noted that don't derive from the same place are all coming from ALL DBMS PRIVILEGES, that's the style of the arrows used in the technical diagrams. I can try to change the style, but just letting you know that this is the default styling.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I thought so, but they look misleading, so I decided to tell you if you can change them somehow.

Copy link
Collaborator

@renetapopova renetapopova Sep 8, 2025

Choose a reason for hiding this comment

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

Screenshot 2025-09-08 at 13 54 58

Copy link
Contributor

@Hunterness Hunterness left a comment

Choose a reason for hiding this comment

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

Review of current state

Status (to help me keep track): 2 open comments

Copy link
Contributor

Choose a reason for hiding this comment

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

I like that this one have arrows, I'd like the other hierarchy ones to also have that

Copy link
Contributor

@Hunterness Hunterness left a comment

Choose a reason for hiding this comment

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

Next round of comments, a lot of them on missing/to much bold :P

Status (for me to keep track): 1 open comment + 4 open comments on the file(s) I didn't re-review due to duplication

Copy link
Contributor

Choose a reason for hiding this comment

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

pattern should be bold

Copy link
Contributor

Choose a reason for hiding this comment

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

the TO in TO role[, ...] should not be bold

@neo4j-docops-agent
Copy link
Collaborator

Copy link
Contributor

@Hunterness Hunterness left a comment

Choose a reason for hiding this comment

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

Looking at most of the updates (skipping the file that now seems duplicated as I don't want to review both and I don't know which is the latest, this also means that all open comments on that file is left as is until I can tick them off)

Copy link
Contributor

Choose a reason for hiding this comment

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

small general nitpick I noticed as I compare with the old ones:
in the *|x[, ...] groups we previously only had the x part italic and not the * (or () or other such syntax characters).
Examples (both from this and other images):

  • (*|user[, ...])
  • *|name[, ...]
  • TO role[, ...]
  • {*|property[, ...]}

Copy link
Contributor

Choose a reason for hiding this comment

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

image image

Still missing ALTER DATABASE privilege between DROP DATABASE and SET DATABASE ACCESS

(replacing comment: #2541 (comment))

Copy link
Contributor

Choose a reason for hiding this comment

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

Screen Shot 09-18-25 at 09 18 AM image

show settings should only go to the name glob bubble and not directly to ON DBMS

Copy link
Contributor

Choose a reason for hiding this comment

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

SHOW ALIAS and ALTER ALIAS is in the wrong order (see #2541 (comment) for context)

Copy link
Contributor

Choose a reason for hiding this comment

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

I just noticed, a lot of these images seem to have transparant background (the checker-pattern shown in the github view) but some doesn't, might be good to be consistent?

Copy link
Contributor

Choose a reason for hiding this comment

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

Still think it looks like the path from GRAPH[S] *|name[, ...] only goes to ELEMENT[S] ... and not the other two paths it can also take

Copy link
Contributor

Choose a reason for hiding this comment

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

why do we now have two files named privileges-on-graph-syntax.svg? I'm gonna skip reviewing both until there is only one so I know which to review...

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.

5 participants