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

Gh-380: Update user guide querying section #393

Merged
merged 54 commits into from
Sep 21, 2023

Conversation

tb06904
Copy link
Member

@tb06904 tb06904 commented Sep 14, 2023

Quite a few changes on this one broken out the pages on the APIs so they each have their own page as an introduction and how to get up and running. Fleshed out the 'querying' section of the user guide with examples and information on the Gaffer querying syntax, including operations and filtering etc.

Its possible more information could be added here in future (e.g. gremlin) but this should serve as a good basis and cover most of what a user might need to know to get familiar with queries.

Note some white space alterations due to merge conflict resolving.

Related Issue

docs/user-guide/apis/java-api.md Outdated Show resolved Hide resolved
docs/user-guide/apis/rest-api.md Outdated Show resolved Hide resolved
docs/user-guide/query/gaffer-syntax/import-export/csv.md Outdated Show resolved Hide resolved
Copy link
Member

@GCHQDeveloper314 GCHQDeveloper314 left a comment

Choose a reason for hiding this comment

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

Few minor comments. The filtering guide is good.

docs/user-guide/query/gaffer-syntax/operations.md Outdated Show resolved Hide resolved
docs/user-guide/query/gaffer-syntax/operations.md Outdated Show resolved Hide resolved
docs/user-guide/query/gaffer-syntax/operations.md Outdated Show resolved Hide resolved
docs/user-guide/apis/rest-api.md Outdated Show resolved Hide resolved
docs/user-guide/query/gaffer-syntax/filtering.md Outdated Show resolved Hide resolved
docs/user-guide/apis/java-api.md Outdated Show resolved Hide resolved
docs/user-guide/apis/java-api.md Outdated Show resolved Hide resolved
@GCHQDeveloper314 GCHQDeveloper314 changed the title Gh-380: user guide on querying Gh-380: Update user guide querying section Sep 21, 2023
@GCHQDeveloper314 GCHQDeveloper314 merged commit a515d2f into v2docs Sep 21, 2023
2 checks passed
@GCHQDeveloper314 GCHQDeveloper314 deleted the gh-380-user-guide-querying branch September 21, 2023 15:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update Querying section in the user guide
4 participants