-
Notifications
You must be signed in to change notification settings - Fork 13
Added page for ending the beta #257
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
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
7d1cb9d
Added page for ending the beta
LackOfMorals 029ae62
Apply suggestions from code review
LackOfMorals fb2079e
Merge branch '6.x' into 6.x
rsill-neo4j 735b4f2
Rename ending-with-the-beta.adoc to end-of-beta-phase.adoc
rsill-neo4j 909886d
Apply suggestions from code review
rsill-neo4j 6ceb3f3
Apply suggestions from code review
rsill-neo4j 34835b8
Update modules/ROOT/pages/aura-graphql/end-of-beta-phase.adoc
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -36,4 +36,7 @@ target/ | |
|
||
# node modules | ||
node_modules/ | ||
.env | ||
.env | ||
|
||
package-lock.json | ||
yarn.lock |
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
Binary file added
BIN
+668 KB
modules/ROOT/images/aura-graphql/console_data_api_confirm_delete_menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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,166 @@ | ||
= End of beta phase | ||
|
||
The beta phase of GraphQL for Neo4j AuraDB will end on the 18th of April 2025. | ||
To prevent data loss and wrap up your beta experience we suggest you take the following steps: | ||
|
||
* Backup GraphQL Data API configuration | ||
* Remove the GraphQL Data API | ||
* Provide feedback | ||
|
||
You are not required to take action. | ||
However, any running GraphQL Data API will be terminated after the 18th of April, resulting in the loss of its configuration information including type definitions. | ||
|
||
|
||
== Backup the GraphQL Data API configuration | ||
|
||
Backing up your GraphQL Data API configuration makes re-use much quicker if you decide to use this feature once it is released. | ||
If you want to run your own GraphQL service instead, the backup might still be useful since it includes the type definitions which can be used for that purpose. | ||
|
||
There are two ways to perform a backup: | ||
|
||
* Manually copy them one by one from the Aura Console | ||
* Using the Aura CLI to obtain everything in a single operation | ||
|
||
|
||
=== Console | ||
|
||
If you want to retain only parts of the configuration, this is a quick method to do so. | ||
If you are intent on backing up all of the configuration, use the xref:#_aura_cli[] instead. | ||
|
||
1. On Aura Console, select **Data API** from the left side navigation. | ||
+ | ||
image::aura-graphql/console_data_api_sidebar.png[] | ||
+ | ||
2. The table shows your GraphQL Data APIs. Use the three dots on the row with the GraphQL Data API that you wish to backup and select **Edit**. | ||
+ | ||
image::aura-graphql/console_data_api_edit_menu.png[] | ||
+ | ||
3. Expand each of the sections and then make a note of the setting or copy as necessary. | ||
+ | ||
image::aura-graphql/console_data_api_edit.png[] | ||
|
||
|
||
=== Aura CLI | ||
|
||
This section assumes that you have configured the Aura CLI. | ||
If you have not, follow the guidance provided in xref:aura-graphql/prerequisites.adoc#_install_and_configure_the_aura_cli[]. | ||
|
||
|
||
1. Look up the Aura instance ID that the GraphQL API is being used with. | ||
+ | ||
[source, bash, indent=0] | ||
---- | ||
aura-cli instance list --output table | ||
---- | ||
+ | ||
|
||
2. From the displayed table, make a note of relevant Aura ID. Use this ID to obtain the ID of the GraphQL API whose configuration you want to back up. | ||
+ | ||
[source, bash, indent=0] | ||
---- | ||
aura-cli data-api graphql list --instance-id YOUR_AURA_INSTANCE_ID --output table | ||
---- | ||
+ | ||
|
||
3. Finally, obtain the configuration of the GraphQL API itself in JSON format. | ||
+ | ||
[source, bash, indent=0] | ||
---- | ||
aura-cli data-api graphql get YOUR_GRAPHQL_DATA_API_ID --instance-id YOUR_AURA_INSTANCE_ID | ||
---- | ||
+ | ||
4. Save the output for future use. | ||
|
||
[NOTE] | ||
==== | ||
Type definitions are stored using Base64 encoding. | ||
Decode them to plain text before using with other systems. | ||
==== | ||
|
||
|
||
== Removing the GraphQL Data API | ||
|
||
Remove the GraphQL Data API either via Aura Console or with the Aura CLI. | ||
|
||
[WARNING] | ||
==== | ||
Once the GraphQL Data API has been deleted, it cannot be recovered. | ||
==== | ||
|
||
|
||
=== Console | ||
|
||
1. In Aura Console, select **Data API** from the left side navigation. | ||
+ | ||
image::aura-graphql/console_data_api_sidebar.png[] | ||
+ | ||
2. The table contains your GraphQL Data APIs. Use the three dots on the row with the GraphQL Data API that you wish to remove and select **Delete**. | ||
+ | ||
image::aura-graphql/console_data_api_delete_menu.png[] | ||
+ | ||
3. Type in the name of your GraphQL API and confirm with **Delete**. | ||
+ | ||
image::aura-graphql/console_data_api_confirm_delete_menu.png[] | ||
|
||
|
||
=== Aura CLI | ||
|
||
This section assumes that you have configured the Aura CLI. | ||
If you have not, follow the guidance provided in xref:aura-graphql/prerequisites.adoc#_install_and_configure_the_aura_cli[]. | ||
|
||
1. Locate the Aura instance ID that the GraphQL API is being used with. | ||
+ | ||
[source, bash, indent=0] | ||
---- | ||
aura-cli instance list --output table | ||
---- | ||
+ | ||
2. From the displayed table, make a note of the relevant Aura ID. Use the ID to obtain the ID of the GraphQL API whose configuration you want to back up. | ||
+ | ||
[source, bash, indent=0] | ||
---- | ||
aura-cli data-api graphql list --instance-id YOUR_AURA_INSTANCE_ID --output table | ||
---- | ||
+ | ||
3. Delete the GraphQL API. | ||
+ | ||
[WARNING] | ||
==== | ||
The Aura CLI does not ask for confirmation and processes the command immediately. | ||
==== | ||
+ | ||
[source, bash, indent=0] | ||
---- | ||
aura-cli data-api graphql delete YOUR_GRAPHQL_DATA_API_ID --instance-id YOUR_AURA_INSTANCE_ID --output table | ||
---- | ||
|
||
|
||
== Provide feedback | ||
|
||
We encourage feedback because it directly impacts the final product. Here's why it matters: | ||
|
||
[square] | ||
* Shape the Product | ||
+ | ||
Your feedback helps us refine features, fix bugs, and improve usability based on real user experiences. | ||
|
||
|
||
* Get a Product That Works for You | ||
+ | ||
By sharing your thoughts, you influence the design and functionality to better meet your needs. | ||
|
||
|
||
* Catch Issues Early | ||
+ | ||
Beta testing allows early identification and resolution of problems before the full release, ensuring a smoother experience. | ||
|
||
|
||
* Improve Performance and Reliability | ||
+ | ||
We rely on real-world usage data to optimize speed, stability, and efficiency. | ||
|
||
|
||
By providing feedback, you're not just testing a product—you’re helping build a better one. | ||
|
||
Please take a few moments to do this in our GitHub repository by (https://github.com/neo4j/graphql/issues/new/choose)[creating an issue] or mailto:jon.giffard@neo4j.com[send an email] | ||
|
||
rsill-neo4j marked this conversation as resolved.
Show resolved
Hide resolved
|
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.