Skip to content

Generate gql-errors index.adoc file #302

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

Merged
merged 11 commits into from
May 6, 2025

Conversation

renetapopova
Copy link
Collaborator

No description provided.

Copy link
Contributor

@l-heemann l-heemann left a comment

Choose a reason for hiding this comment

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

I think we can improve how the pages are generated (especially once Neo4j has a procedure or file with all the GqlCodes) but for now the generated results look good 👍

@renetapopova renetapopova force-pushed the dev-index-generation branch from a6ad8e4 to 53ea84f Compare May 1, 2025 13:37
@renetapopova renetapopova requested a review from l-heemann May 6, 2025 10:58
Copy link
Contributor

@l-heemann l-heemann left a comment

Choose a reason for hiding this comment

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

Haven't read the code in great detail, but it looks alright from an overview.

I still consider the reliance on so many regexes a risk. But I also see no alternative to regexes unless we change to using a different data source (e.g. csv/json) which we decided against.

# 3. If validation passes, replace index.adoc with auto-index.adoc

set -e # Exit on any error
# Script to validate and update the GQL error index
Copy link
Contributor

Choose a reason for hiding this comment

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

More of a FYI; it is possible to run one python file from another, something along the lines of

import validate-error-index
validate-error-index.main()

I like to avoid bash if I can. But I don't know what you usually do in docs, so follow whatever is standard there 🤷

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I don't think we have a standard. I replaced it with python.

@neo4j-docops-agent
Copy link
Collaborator

neo4j-docops-agent commented May 6, 2025

Thanks for the documentation updates.

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

@renetapopova
Copy link
Collaborator Author

Haven't read the code in great detail, but it looks alright from an overview.

I still consider the reliance on so many regexes a risk. But I also see no alternative to regexes unless we change to using a different data source (e.g. csv/json) which we decided against.

These scripts only generate the index file from the individual files. We'll add another check for the discrepancies between the codebase and the docs. And of course, we can still improve the approach for generating the index.adoc. at a later time.

@renetapopova renetapopova merged commit dc6b4b3 into neo4j:dev May 6, 2025
4 checks passed
@renetapopova renetapopova deleted the dev-index-generation branch May 6, 2025 14:00
renetapopova added a commit to renetapopova/docs-status-codes that referenced this pull request May 6, 2025
renetapopova added a commit to renetapopova/docs-status-codes that referenced this pull request May 6, 2025
renetapopova added a commit that referenced this pull request May 6, 2025
renetapopova added a commit that referenced this pull request May 6, 2025
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