-
Notifications
You must be signed in to change notification settings - Fork 12
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
Add data api docs #224
Add data api docs #224
Conversation
In Foreword Stay in touch: Use email ([email protected]), our #graphal channel on our Discord Community, or our forums to report issues, suggest improvements, or ask questions. typo in discord channel. should be Stay in touch: Use email ([email protected]), our #graphql channel on our Discord Community, or our forums to report issues, suggest improvements, or ask questions. |
Pre-reqs Rewording of Management of the beta of GraphQL for Neo4j AuraDB is performed using the Aura CLI command line tool. Future versions will be fully integrated with the Aura Console. The Aura CLI will need to be installed and configured for this purpose. To Management of the beta of GraphQL for Neo4j AuraDB is performed using the Aura CLI command line tool which will need to be installed. Future versions of GraphQL for Neo4j AuraDB will be fully integrated with the Aura Console. |
Change Read This Before you Start to Read This Before You Start |
a note about screenshots - they include @LackOfMorals 's account data. we should probably blur that out or replace it with something generic (John Doe style) |
I don't think there's anything too sensitive there right? It's just email (which @LackOfMorals wants to share in these docs for feedback anyway), instanceId (for a short lived testing instance which is probably already deleted and if not is easy to change) and the tenantId |
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.
not finished yet, but going file by file (since there are incoming commits)
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.
prerequisites section
5. On the pop-up window, enter a Client name, and select Create | ||
6. You will be shown the newly created Client ID and Client Secret. Make sure to securely save these as they are required to use the Aura CLI | ||
|
||
== Install & Configure the Aura CLI |
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'd argue that installation is the next step after prerequisites, and move the installation sections to their own file. what do you think?
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 the reasoning here is that having the aura-cli installed is a prerequisite. It's not part of the GraphQL for Aura offering and is a standalone tool in the same way that the Aura console is a standalone tool that we're adding to
Co-authored-by: Richard Sill <[email protected]>
these three were outdated before they could be applied
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.
deploy and operate section
modules/ROOT/pages/aura-graphql-data-apis/deploy-and-operate.adoc
Outdated
Show resolved
Hide resolved
modules/ROOT/pages/aura-graphql-data-apis/deploy-and-operate.adoc
Outdated
Show resolved
Hide resolved
deploy and operate section
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.
authentication providers section
modules/ROOT/pages/aura-graphql-data-apis/authentication-providers.adoc
Outdated
Show resolved
Hide resolved
modules/ROOT/pages/aura-graphql-data-apis/authentication-providers.adoc
Outdated
Show resolved
Hide resolved
modules/ROOT/pages/aura-graphql-data-apis/authentication-providers.adoc
Outdated
Show resolved
Hide resolved
authentication providers section
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.
using your api section
using your api section
i double-checked with @AlexicaWright - |
Okay, @LackOfMorals just provided blurred images so I've just updated it to use those instead |
Thanks for the documentation updates. The preview documentation has now been torn down - reopening this PR will republish it. |
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.
cropped the images (to not show the browser) and blurred the avatar images
Closing in favour of #226 |
Add docs for the open beta of GraphQL in Aura