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

Add data api docs #224

Closed

Conversation

Liam-Doodson
Copy link
Contributor

Add docs for the open beta of GraphQL in Aura

@LackOfMorals
Copy link

LackOfMorals commented Jan 9, 2025

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.

@LackOfMorals
Copy link

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.

@LackOfMorals
Copy link

Change Read This Before you Start to Read This Before You Start

@rsill-neo4j
Copy link
Contributor

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)

@Liam-Doodson
Copy link
Contributor Author

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

Copy link
Contributor

@rsill-neo4j rsill-neo4j left a 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)

modules/ROOT/pages/aura-graphql-data-apis/index.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/aura-graphql-data-apis/index.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/aura-graphql-data-apis/index.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/aura-graphql-data-apis/index.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/aura-graphql-data-apis/index.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/aura-graphql-data-apis/index.adoc Outdated Show resolved Hide resolved
Copy link
Contributor

@rsill-neo4j rsill-neo4j left a 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
Copy link
Contributor

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?

Copy link
Contributor Author

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

these three were outdated before they could be applied
Copy link
Contributor

@rsill-neo4j rsill-neo4j left a 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

deploy and operate section
Copy link
Contributor

@rsill-neo4j rsill-neo4j left a comment

Choose a reason for hiding this comment

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

authentication providers section

authentication providers section
Copy link
Contributor

@rsill-neo4j rsill-neo4j left a 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
@rsill-neo4j
Copy link
Contributor

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

i double-checked with @AlexicaWright -
our public documentation should expose neither a personal email address nor personal account details, because of the visibility on a public website. would the discord channel and the forum link suffice as feedback channels?

@Liam-Doodson
Copy link
Contributor Author

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

i double-checked with @AlexicaWright - our public documentation should expose neither a personal email address nor personal account details, because of the visibility on a public website. would the discord channel and the forum link suffice as feedback channels?

Okay, @LackOfMorals just provided blurred images so I've just updated it to use those instead

@neo-technology-commit-status-publisher
Copy link
Collaborator

Thanks for the documentation updates.

The preview documentation has now been torn down - reopening this PR will republish it.

Copy link
Contributor

@rsill-neo4j rsill-neo4j left a 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

@Liam-Doodson
Copy link
Contributor Author

Closing in favour of #226

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.

4 participants