Skip to content

Conversation

@darrellwarde
Copy link
Contributor

Adds a more step by step guide to Federation. Also adds instructions on how to optimally create a new project.

Fixes some markdown style code blocks.

@darrellwarde darrellwarde requested a review from lidiazuin August 4, 2023 12:36
@neo-technology-commit-status-publisher
Copy link
Collaborator

Looks like you've updated the documentation!

Check out your changes at https://neo4j-docs-graphql-9.surge.sh

Copy link
Contributor

@lidiazuin lidiazuin left a comment

Choose a reason for hiding this comment

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

I'm not sure if we need the create-project.adoc if considered what we have in getting-started/index.adoc. Please check this PR #8 to make sure it's the same thing so we can make adjustments . Thanks!

Copy link
Contributor

@lidiazuin lidiazuin left a comment

Choose a reason for hiding this comment

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

I'm not sure if we need the create-project.adoc if considered what we have in getting-started/index.adoc. Please check this PR #8 to make sure it's the same thing so we can make adjustments . Thanks!

@darrellwarde
Copy link
Contributor Author

I'm not sure if we need the create-project.adoc if considered what we have in getting-started/index.adoc. Please check this PR #8 to make sure it's the same thing so we can make adjustments . Thanks!

My thinking was that creating a project is going to be a fairly common step in many different how-to guides, so we should maybe have a centralised how-to guide on this which all of those other guides can point to.

We can't point to the Getting Started guide because it's a much more holistic example, containing steps further than what most guides will need.

If we repeat ourselves in various different guides, they are not going to get updated so there will be discrepancies across the docs. That was my thinking anyway!

darrellwarde and others added 2 commits August 30, 2023 17:24
Co-authored-by: Lidia Zuin <102308961+lidiazuin@users.noreply.github.com>
Co-authored-by: Lidia Zuin <102308961+lidiazuin@users.noreply.github.com>
@neo-technology-commit-status-publisher
Copy link
Collaborator

neo-technology-commit-status-publisher commented Aug 30, 2023

Thanks for the documentation updates.

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

@darrellwarde
Copy link
Contributor Author

I'm not sure if we need the create-project.adoc if considered what we have in getting-started/index.adoc. Please check this PR #8 to make sure it's the same thing so we can make adjustments . Thanks!

I've gotten rid of this now to get this PR ready to merge - hopefully this is now less of a controversial PR!

Copy link
Contributor

@lidiazuin lidiazuin left a comment

Choose a reason for hiding this comment

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

LGTM! I only want to make some changes later on when turning some things into lists :) thanks for your work!

@darrellwarde darrellwarde merged commit eabe4a2 into neo4j:main Aug 31, 2023
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.

3 participants