Skip to content
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

GQL framework #212

Merged
merged 29 commits into from
Nov 29, 2024
Merged

Conversation

renetapopova
Copy link
Collaborator

No description provided.

@renetapopova
Copy link
Collaborator Author

renetapopova commented Nov 20, 2024

Comments from Gowri:

  • The first lines in the ‘Server errors page’ mention that the GQL information is shown via driver and then we mention ‘Starting from version 5.25’ this is exposed to users. Only the Query.log changes are exposed from 5.25, the driver changes will be seen only from 5.26. - DONE
  • ‘Starting from version 5.25, the Neo4j error codes have an additional GQL-status object’ can we change this to ‘Starting from version 5.25, the Neo4j error codes have an additional GQL-status object along with legacy errors’ .This is just to be a bit more explicit. - DONE
  • Under ‘Classes of GQLSTATUS error codes’ section, you mentioned that Neo4j subclass starts N. Can we add a sentence to mention that any subclass not starting with N is a standard code. - DONE
  • The topic ‘Server error classification’ is after the section, Legacy errors. As we are talking about the GQLSTATUS object classifications, do we want to move this before the Legacy errors heading? - The classification covers both GQLSTATUS and Neo4j Status errors, so that's why it follows both "object" sections.
  • Under topic ‘Error internals’, we are talking about driver emitting GQL information. Do we change ‘Starting from 5.25,’ to ‘Starting from 5.26’? - Need to check with Louise on this/
  • Topic ‘Query logging’, the default GQL codes highlighted in green , need to be at the top of the page. This way this can be the same for both drivers and Query.log. - I don't understand what this refers to.
  • Topic ‘Server-driver version compatibility’ - There is a link to bolt and server compatibility. We need to mention from which bolt and Driver version, does the users get the additive GQL information. More like the table Louise Berglund has in her technical documentation. I really like the ‘Server-driver version compatibility’ for notifications. We can take inspiration from here too. - This section hasn't been written yet. It's just a placeholder for Louise.
  • Status description explanation mentions class subclass and message in ‘Server errors’ page. One example in the next page ‘List of GQL status error codes’ is Status description error: connection exception - transaction resolution unknown. Will it help to include a format like error: class - subclass. Message in the explanation section? We do say that with different words: "A human-readable description of the GQLSTATUS, which consists of a condition, a subcondition, and a description.
    The condition and subcondition are textual representations of the class and subclass codes, respectively." I am not sure what your suggestion is here.

Copy link
Contributor

@Lojjs Lojjs left a comment

Choose a reason for hiding this comment

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

A lot of feedback coming here. Feel free to first fix easy stuff and then give me a call to discuss or whatever you find easiest.

modules/ROOT/pages/errors/all-errors.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/errors/all-errors.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/errors/all-errors.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/errors/all-errors.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/errors/all-errors.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/errors/index.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/errors/index.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/errors/index.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/errors/index.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/errors/index.adoc Show resolved Hide resolved
@Lojjs Lojjs self-assigned this Nov 21, 2024
@renetapopova renetapopova requested a review from Lojjs November 28, 2024 10:14
@renetapopova renetapopova requested a review from hvub November 28, 2024 14:35
@renetapopova renetapopova removed the request for review from ggowrimani November 28, 2024 14:35
Copy link
Contributor

@Lojjs Lojjs left a comment

Choose a reason for hiding this comment

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

Thanks for all the hard work on this one 👏

Copy link
Contributor

@hvub hvub left a comment

Choose a reason for hiding this comment

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

This looks all pretty good. All the comments are just little things I noticed while reading. Feel free to do with that as you see fit. :-)

modules/ROOT/pages/errors/all-errors.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/errors/all-errors.adoc Show resolved Hide resolved
modules/ROOT/pages/errors/all-errors.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/errors/all-errors.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/errors/all-errors.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/errors/index.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/index.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/notifications/all-notifications.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/notifications/all-notifications.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/notifications/index.adoc Outdated Show resolved Hide resolved
@neo-technology-commit-status-publisher
Copy link
Collaborator

Thanks for the documentation updates.

The preview documentation has now been torn down - reopening this PR will republish it.

@renetapopova renetapopova merged commit 2b83650 into neo4j:gqlstatus-errors Nov 29, 2024
5 checks passed
@renetapopova renetapopova deleted the gql-framework2 branch November 29, 2024 11:54
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.

6 participants