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

basics of cloudflare / AWS / firebase deployment instructions #335

Merged
merged 14 commits into from
May 1, 2020

Conversation

aholtzman
Copy link
Member

Related Issue

resolves #326

Summary of Changes

  1. Added MD file for cloudflare workers deployment

there was no guides/tutorials directors in the master branch at this time, so just added to the 'pages' folder for now.

@thescientist13
Copy link
Member

Hmm, another case of puppeteer "failing" on Netlify?

9:57:19 AM: webpack build complete
9:57:49 AM: TimeoutError: Timed out after 30000 ms while trying to connect to Chrome! The only Chrome revision guaranteed to work is r686378
9:57:49 AM: error Command failed with exit code 1.
9:57:49 AM: info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
9:57:49 AM: Skipping functions preparation step: no functions directory set

Copy link
Member

@thescientist13 thescientist13 left a comment

Choose a reason for hiding this comment

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

Awesome guide @aholtzman , thank you so much !

Left a couple small comments but otherwise no real issues here. Will merge this once #314 is merged, which will introduce the top level guides page where this file can then be place.

@@ -0,0 +1,56 @@
## Cloudflare Workers Deployment

[Cloudflare Workers](https://workers.cloudflare.com/) is an excellent option as a CDN for deploying your Greenwood site, though if your are new to using this service consider deploying with [Netlify](https://www.netlify.com) as it is a simpler process.
Copy link
Member

@thescientist13 thescientist13 Apr 19, 2020

Choose a reason for hiding this comment

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

though if your are new

I think this might mean to be "though if you are new"


When completed a url for workers subdomain will be printed in your terminal.

To have automatic deployments whenever you push updates to your repo, you will need to configure GitHub actions to accomplish this, otherwise you can push updated manually but running the _build_ and _publish_ commands each time you wish to update the site.
Copy link
Member

Choose a reason for hiding this comment

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

Do you happen to have a link to one of those GitHub actions by chance? Might be cool to link here.

Copy link
Member Author

Choose a reason for hiding this comment

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

I have not yet tried this myself, but the Gatsby documentation for cloudflare deployment mentions this. I will be trying this out at work this week and can add an additional guide for this or append this one once I have it worked out.

@thescientist13 thescientist13 added the website Tasks related to the projects website / documentation label Apr 19, 2020
@thescientist13
Copy link
Member

Nice @aholtzman , looks like you were able to get it working.

Maybe a cool "side" project for the Greenwood team would be to make a Docker container and GitHub Action for building Greenwood, to help support on the Chromium dependency. I'm sure it could also be made in such a way so as to apply to most CI environments (CircleCI, Travis).

Will add it as an idea to the Trello board. 👍

OPTIONS: "--acl public-read"
```

In the same directory as main.yml create a file 'chromium-lib-install.sh'
Copy link
Member

@thescientist13 thescientist13 Apr 28, 2020

Choose a reason for hiding this comment

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

yeah, will definitely make an issue for this. Would be annoying if everyone needs to set these up all the time if they want to use our project. I know other projects like Scully use puppeteer, I wonder if they also need to do the same thing? 🤔

Copy link
Member

@thescientist13 thescientist13 left a comment

Choose a reason for hiding this comment

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

@aholtzman
I think you may have run an npm install inadvertently. Can you revert the addition of package-lock.json and the changes to package.json please?

Copy link
Member

@thescientist13 thescientist13 left a comment

Choose a reason for hiding this comment

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

@aholtzman
Merged @hutchgrant 's work, if you can just pull in master and move your content into pages/guides, then you can use markdown to organize your content within the menu.

@thescientist13 thescientist13 changed the title basics of cloudflare deployment instructions basics of cloudflare / AWS / firebase deployment instructions Apr 29, 2020
@aholtzman aholtzman force-pushed the guide/cloudflare-workers-deploy branch from 76ee9df to 30eadb6 Compare April 29, 2020 14:00
Copy link
Member

@thescientist13 thescientist13 left a comment

Choose a reason for hiding this comment

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

Not a big deal, but the position of the carrot looks off in wider breakpoints.
Screen Shot 2020-04-29 at 5 53 48 PM

Maybe something to circle back to as part of #325 / #112 ?

cc: @hutchgrant


also, if possible on PRs let's please try and reference the issue number in the branch name 🙏 , e.g. guide/issue-123-guide-for-xyz

Thanks!

Copy link
Member

@thescientist13 thescientist13 left a comment

Choose a reason for hiding this comment

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

@aholtzman
One thing I really liked about the guide @hutchgrant put together was the addition of screenshoots. Sometimes really helpful for settings / admin panels in these kinds of tools. Just a thought, maybe something you would mind adding in a follow PR?

Suggestions:

  • AWS: AWS CloudFront for CDN
  • AWS: Setup S3 for Hosting
  • Firebase: Deploy on Firebase (for the new project flow)
  • Firebase: Auto Deployment with GitHub Actions (adding the FIREBASE_TOKEN)

@thescientist13 thescientist13 merged commit d6eef76 into master May 1, 2020
@thescientist13 thescientist13 deleted the guide/cloudflare-workers-deploy branch May 1, 2020 00:48
@thescientist13 thescientist13 mentioned this pull request Sep 22, 2020
53 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Guide website Tasks related to the projects website / documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create guide(s) for deploying / hosting Greenwood sites (CloudFlare workers, AWS, Firebase)
2 participants