-
Notifications
You must be signed in to change notification settings - Fork 81
Images refresh batch 2 #2541
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: dev
Are you sure you want to change the base?
Images refresh batch 2 #2541
Conversation
…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.
On the page Database privileges, Figure 2. Syntax of GRANT and DENY database privileges is not updated. |
On the page DBMS privileges, the Figure 1. Syntax of GRANT and DENY DBMS privileges is not updated. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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"] |
There was a problem hiding this comment.
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] |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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)
There was a problem hiding this comment.
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 🤷
modules/ROOT/images/privileges-grant-and-deny-syntax-database-privileges.svg
Show resolved
Hide resolved
There was a problem hiding this 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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
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
modules/ROOT/pages/authentication-authorization/database-administration.adoc
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
modules/ROOT/pages/authentication-authorization/load-privileges.adoc
Outdated
Show resolved
Hide resolved
modules/ROOT/pages/authentication-authorization/dbms-administration.adoc
Outdated
Show resolved
Hide resolved
modules/ROOT/images/privileges-grant-and-deny-syntax-load-privileges.svg
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this 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
modules/ROOT/images/privileges-grant-and-deny-syntax-database-privileges.svg
Show resolved
Hide resolved
modules/ROOT/images/privileges-grant-and-deny-syntax-dbms-privileges.svg
Show resolved
Hide resolved
modules/ROOT/images/privileges-grant-and-deny-syntax-load-privileges.svg
Show resolved
Hide resolved
There was a problem hiding this comment.
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
There was a problem hiding this 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
modules/ROOT/images/privileges-grant-and-deny-syntax-database-privileges.svg
Show resolved
Hide resolved
modules/ROOT/images/privileges-grant-and-deny-syntax-database-privileges.svg
Show resolved
Hide resolved
modules/ROOT/images/privileges-grant-and-deny-syntax-database-privileges.svg
Show resolved
Hide resolved
modules/ROOT/images/privileges-grant-and-deny-syntax-dbms-privileges.svg
Show resolved
Hide resolved
modules/ROOT/images/privileges-grant-and-deny-syntax-dbms-privileges.svg
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
pattern
should be bold
There was a problem hiding this comment.
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
modules/ROOT/images/privileges-grant-and-deny-syntax-dbms-privileges.svg
Show resolved
Hide resolved
This PR includes documentation updates Updated pages: |
There was a problem hiding this 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)
modules/ROOT/images/privileges-grant-and-deny-syntax-database-privileges.svg
Show resolved
Hide resolved
There was a problem hiding this comment.
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[, ...]}
modules/ROOT/images/privileges-grant-and-deny-syntax-load-privileges.svg
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.


Still missing ALTER DATABASE
privilege between DROP DATABASE
and SET DATABASE ACCESS
(replacing comment: #2541 (comment))
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
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)
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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...
No description provided.