search

aerogear / graphback

Graphback - Out of the box GraphQL server and client
https://graphback.dev
Apache License 2.0
409 stars 73 forks source link

Docs issues #888

Closed wtrocki closed 4 years ago

wtrocki commented 4 years ago

1) Database migrations do not mention that they are only for postgress. https://graphback.dev/docs/intro/concepts#database-migrations

2) https://graphback.dev/docs/intro/datamodel needs to be extended.

A simple use case is needed. Then follow up an example with relationships. Then we might bring some table mapping and id annotations

Generally, people should be able to get a sense how to create most of the model use cases in less than 5 minutes

3) https://graphback.dev/docs/intro/config

Config - Db migrations should mention that they work only with Postgress data source and for MongoDB there is no need to have DB migrations section at all.

4) https://graphback.dev/docs/intro/usecases

4rd use case should be added mention graphql serve

Tasks

craicoverflow commented 4 years ago

I don't see much value in the Getting Started > Concepts page. The sections do highlight some nice things about Graphback, but for someone looking to just use Graphback they might not be that important.

Plugins are useful to bring custom stuff but many people won't need to ever add one. The same goes for Graphback CRUD Runtime here. It doesn't tell me anything I absolutely need to know to get started. Database migrations are not needed by everyone necessarily, and this section does not add anything more than what is specified in What is Graphback > What Graphback can do for you?. Integration with existing GraphQL Ecosystem is also a nice to know fact for some people, but not for most.

The whole page is not needed in my opinion. With a well thought out sidebar users can see that we have Plugins, Database Migrations, CRUD spec from the link titles and click them as they need to use them.

wtrocki commented 4 years ago

1) https://graphback.dev/docs/plugins/crud-resolvers Plugin mentions runtime. We should link to examples rather than putting this into plugin

wtrocki commented 4 years ago

This can be removed: https://graphback.dev/docs/crud/crudmapping

wtrocki commented 4 years ago

https://graphback.dev/docs/db/dbintroduction - We should reference that we support Postgres only

wtrocki commented 4 years ago

https://graphback.dev/docs/db/datasources - is in wrong chapter Database chapter can be renamed to Database migrations

wtrocki commented 4 years ago

Migrating to Graphback -> Migrating from REST

craicoverflow commented 4 years ago

Migrating to Graphback -> Migrating from REST

So right now this makes sense as we only have information for how to migrate from REST. Will we be looking to add sections in the future for Migrating from Prisma, AppSync etc?

So instead of:

Migrating to Graphback
  - Migrate to Graphback
  - OpenAPI Migrations

there could be:

Migrating to Graphback
  - REST
  - Prisma
  - Etc
wtrocki commented 4 years ago

Yep. GraphQL Mesh could be good to get numbers of migrations. Then we can also get guide from Prisma or Aws

craicoverflow commented 4 years ago

graphback.dev/docs/db/datasources - is in wrong chapter

Hmm where do you think this should be? CRUD?