redwood icon indicating copy to clipboard operation
redwood copied to clipboard

Update deployment.md

Open Ayo-faks opened this issue 2 years ago • 7 comments

Deploying to Netlify was a bit misleading. Not inputting the database URI as an environment variable in the netlify deploy settings leads to the build process throwing errors. I edited it to reflect adding the database URI as an environment variable so Netlify can detect and migrate our database.

Ayo-faks avatar Aug 03 '22 14:08 Ayo-faks

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 1fbe8fd45a46cb8f5c08b7ac8cda45e0ddebc30b. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch


✅ Successfully ran 14 targets

Sent with 💌 from NxCloud.

nx-cloud[bot] avatar Aug 03 '22 14:08 nx-cloud[bot]

Deploy Preview for redwoodjs-docs ready!

Name Link
Latest commit 1fbe8fd45a46cb8f5c08b7ac8cda45e0ddebc30b
Latest deploy log https://app.netlify.com/sites/redwoodjs-docs/deploys/62ea816678b7930008e7325d
Deploy Preview https://deploy-preview-6116--redwoodjs-docs.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

netlify[bot] avatar Aug 03 '22 14:08 netlify[bot]

Thanks @Ayo-faks for this PR, Netlify is the first provider we've worked with, it needs proper care indeed!

noire-munich avatar Aug 05 '22 14:08 noire-munich

Thanks @Ayo-faks! Before I suggest any changes, let me get @cannikin's thoughts on merging the "Environment variables" section into the "Signup" section. It seems ok to me but what do you think?

jtoar avatar Aug 06 '22 08:08 jtoar

Hi,

It's also fine by me. But you seek cannikin https://github.com/cannikin's opinion

Cheers

On Sat, 6 Aug 2022, 10:00 Dominic Saadi, @.***> wrote:

Thanks @Ayo-faks https://github.com/Ayo-faks! Before I suggest any changes, let me get @cannikin https://github.com/cannikin's thoughts on merging the "Environment variables" section into the "Signup" section. It seems ok to me but what do you think?

— Reply to this email directly, view it on GitHub https://github.com/redwoodjs/redwood/pull/6116#issuecomment-1207178234, or unsubscribe https://github.com/notifications/unsubscribe-auth/AQLZDMDW5BK6OM3DQYBGJLTVXYSRHANCNFSM55PAB22Q . You are receiving this because you were mentioned. Message ID: @.***>

Ayo-faks avatar Aug 06 '22 09:08 Ayo-faks

@Ayo-faks ah sorry, that was poor writing on my part. That question was meant for @cannikin but it doesn't read that way at all 😅

jtoar avatar Aug 06 '22 09:08 jtoar

Lol. No worries

On Sat, 6 Aug 2022, 10:22 Dominic Saadi, @.***> wrote:

@Ayo-faks https://github.com/Ayo-faks ah sorry, that was poor writing on my part. That question was meant for @cannikin https://github.com/cannikin but it doesn't read that way at all 😅

— Reply to this email directly, view it on GitHub https://github.com/redwoodjs/redwood/pull/6116#issuecomment-1207181426, or unsubscribe https://github.com/notifications/unsubscribe-auth/AQLZDMASZTL2WLZIHFB6Y5LVXYVDZANCNFSM55PAB22Q . You are receiving this because you were mentioned.Message ID: @.***>

Ayo-faks avatar Aug 06 '22 09:08 Ayo-faks

Thanks for the PR! So I make a point of telling people about the build error that will occur doing that first deploy in the text there, I don't think it's too misleading?

  1. Setup site, point to GitHub
  2. Build errors :(
  3. Now add missing environment variables
  4. Build succeeds :)

It goes along with whole ethos of the tutorial, where sometimes we write some code just to see what will happen, then correct it later. I'm trying to group each thing in logical chunks: initial site setup is one mental grouping of tasks, configuring environment variables is another. And the fact that it's covered as its own topic makes it (hopefully) easy to refer back to in your mental model when it comes time to add your own ENV vars in the future.

I can see that if you only followed along in the tutorial sentence-by-sentence, it may be a surprise to get that build error. But I prefer that over giving them too many things to do at once, and effectively saying "just copy and paste everything I'm doing, don't worry about what's happening." It's like getting directions from your GPS: it's much better (to me, at least) to get feedback as I'm driving about where to make turns as they're happening, than to just see a big list of directions at the start of the trip that I then need to try and remember while driving.

What do you think?

cannikin avatar Aug 16 '22 20:08 cannikin

What do you think?

Not sure an answer would be expected from me :p though!

I wondered why I was reading not as you intended it to be read @cannikin and the reason is easy: I have not done the tutorial in over 2 years. When looking for the info, I arrived from the Reference, which felt like missing the info I needed but redirected me to the tutorial. I'm confident I know enough about Redwood so I skip reading carefully and read sentence by sentence, defeating the purpose of the tutorial. My shame, clearly.

I would advocate for keeping the tutorial as you wrote it - full process included, and stuff up a bit more the reference to make sure we don't need to redirect to the tutorial.

noire-munich avatar Aug 17 '22 15:08 noire-munich

Closing this one due to inactivity and @cannikin's last response, but happy to reopen and reconsider.

jtoar avatar Jan 21 '23 21:01 jtoar