-
Notifications
You must be signed in to change notification settings - Fork 14
Rework index #275
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
Rework index #275
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
9652411
created new pages, slimmed down the introduction
rsill-neo4j 4f97601
moved a section
rsill-neo4j 5c42503
Update modules/ROOT/pages/versioning.adoc
rsill-neo4j 8010594
review suggestions
rsill-neo4j 4fbe814
path change
rsill-neo4j 208f605
restored intro, restored order for 'how it works' section
rsill-neo4j File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
= Integrating the library | ||
:description: Learn how to use the Neo4j GraphQL Library with your technology stack. | ||
|
||
|
||
== Interaction | ||
|
||
In xref::getting-started/graphql-aura.adoc[] as well as xref::getting-started/graphql-self-hosted.adoc[], a GraphQL server serves the GraphQL schema, so you can interact directly with your API with no frontend. | ||
In case you prefer to use frontend frameworks, these are some clients that interact with GraphQL APIs: | ||
|
||
- https://reactjs.org/[React] - support through https://www.apollographql.com/docs/react/[Apollo Client] | ||
- https://vuejs.org/[Vue.js] - support through https://apollo.vuejs.org/[Vue Apollo] | ||
- https://angularjs.org/[AngularJS] - support through https://apollo-angular.com/docs/[Apollo Angular]. | ||
|
||
|
||
== Deployment | ||
|
||
There are a variety of methods for deploying GraphQL APIs. | ||
|
||
With Aura Console, you can create and use a GraphQL API, see xref::getting-started/graphql-aura.adoc[]. | ||
|
||
The xref::getting-started/graphql-self-hosted.adoc[] guide uses Apollo Server. | ||
You can check the Apollo documentation on https://www.apollographql.com/docs/apollo-server/deployment[Deployment] for more details. | ||
|
||
|
||
== Requirements | ||
|
||
. https://neo4j.com/product/auradb/[Neo4j AuraDB] version 2025.x or https://neo4j.com/deployment-center/#gdb-selfmanaged[Neo4j Database] running the latest 5.x version or above with the APOC core plugin. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
= Versioning | ||
:description: The approach to versioning of the Neo4j GraphQL Library. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is it worth mentioning the LTS vs latest approach? Currently version 5 is LTS, which is still maintained but no new features are added, whilst version 7 (recommended) is actively being worked on |
||
|
||
|
||
== LTS version | ||
|
||
GraphQL Library version 5 is the long-term support (LTS) version. | ||
It is maintained but no new features are added to it. | ||
|
||
Version 7 is the recommended version and actively being developed. | ||
|
||
|
||
== Semantic versioning | ||
|
||
The Neo4j GraphQL Library uses https://semver.org/[Semantic Versioning]. | ||
Given a version number `MAJOR.MINOR.PATCH`, the increment is based on: | ||
|
||
- `MAJOR` - incompatible API changes compared to the previous `MAJOR` version, for which you will likely have to migrate. | ||
- `MINOR` - new features have been added in a backwards compatible manner. | ||
- `PATCH` - bug fixes have been added in a backwards compatible manner. | ||
|
||
Additionally, prerelease version numbers may have additional suffixes, for example `MAJOR.MINOR.PATCH-PRERELEASE.NUMBER`, where `PRERELEASE` is one of the following: | ||
|
||
- `alpha` - unstable prerelease artifacts, and the API may change between releases during this phase | ||
- `beta` - feature complete prerelease artifacts, which will be more stable than `alpha` releases but will likely still contain bugs | ||
- `rc` - release candidate including artifacts to be promoted to a stable release, in a last effort to find trailing bugs. | ||
|
||
`NUMBER` in the suffix is simply an incrementing release number in each phase. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 would consider putting the query first, along with an example response, as this feels like the most prominent and use case