-
Notifications
You must be signed in to change notification settings - Fork 27
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
Conversation
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 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 👍
…a template and populates the codes, update the verification, add bash to automate the workflow, and add a readme
a6ad8e4
to
53ea84f
Compare
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.
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.
scripts/update-gql-error-index.sh
Outdated
# 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 |
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.
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 🤷
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 think we have a standard. I replaced it with python.
Thanks for the documentation updates. The preview documentation has now been torn down - reopening this PR will republish it. |
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. |
No description provided.