Skip to content

[docs, feature]: Feedback in general #18

@jsjoeio

Description

@jsjoeio

I think the setup instructions could be clarified to make it easier for first-time users. For instance, following the instructions, I get this after starting the app:

image

I know this is because the server isn't running and hasn't generated the queries but ideally, the setup should walk me through the entire setup (including the Relay part) before telling me to start the app.

Another thing that isn't clear is if I need to use two separate OneGraph apps? I am guessing no, but in the Setup part, you say use your "app's id". But then in the Relay part you say create a new app. I think we could clarify this section to avoid any confusion.

Also, I think we should try to solidify the use of env variables. There's a .env but then in the relay part, it tells me to add them inline with the yarn relay --watch command. It would be nice if I just added them to the .env.

While all of these may sound "negative", I do think this project is awesome and I know it's still very early on, but I did get things running :)

image

Last thing, I don't know the best solution, but the "issue" is having all the types of deployments in this one example. Now, to deploy to Netlify, I have to go delete the firebase, fly, now, files. Maybe instead you could do what services like Next.js and Nest.js do where you have a directory with examples:

Also, not your fault, but Netlify failed with I tried to deploy :( Something happened with the authorization? I ran yarn deploy:netlify, it opened a tab in my browser, I logged in and gave it permission then went back and reran the command but it failed saying unauthorized. Will figure this out. But might be worth noting in the docs.

image

Hmm...tried to deploy by connecting site to Netlify and it didn't work.
image

Looks like something went wrong with my functions maybe:
image

I'll have to investigate a bit further but I'm sure I can figure it out.

Summary of Feedback

Doc fixes

  • Rewrite Setup instructions to be more hold user's hand more
  • Decide on consistent user of environment variables
  • Refactor the main example and create /examples directory

Bugs

  • couldn't deploy to Netlify from command line (bug with Netlify?)

Feature Requests

  • OneGraph OneBlog CLI tool to generate boiler plate. It would ask what service you want to use (i.e. Firebase, now, Netlify), and then you wouldn't have all the unnecessary files

P.S. - this is the first time I've heard of Grommet. Looks pretty nice! 👌🏼

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions