Skip to content

Inline Dockerfile and gcloud commands. #28

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

Closed

Conversation

josephburnett
Copy link

Add Dockerfile and gcloud commands to README.

It isn't clear how to deploy the same function to all three environments, Cloud Functions, Cloud Run and Cloud Run on GKE. What's missing is a Dockerfile and example gcloud commands. There are links to the relevant quickstarts, but it made me think I was in the wrong place.

Add Dockerfile and gcloud commands to README.

It isn't clear how to deploy the same function to all three environments, Cloud Functions, Cloud Run and Cloud Run on GKE.  What's missing is a Dockerfile and example gcloud commands.  There are links to the relevant quickstarts, but it made me think I was in the wrong place.
@grant
Copy link
Contributor

grant commented May 20, 2019

@josephburnett Thanks for the PR, this is very useful.
However, can you open an issue first? There are some questions we should ask first.

For example, I think this Dockerfile should live in an examples/ folder or somewhere besides the README.md.

In addition, I don't think we want to tie the functions framework to gcloud or runtimes like nodejs8. These commands will change with time and we should be careful about maintaining them.

@stew-r
Copy link
Contributor

stew-r commented May 20, 2019

+1 to grant's comment. IMO this belongs in a Medium/blog post rather than as content that we own and maintain. What if we posted this elsewhere and just linked to it from the repo (e.g., "here's a collection of great links that show you how to do things with the Functions Framework")?

@AndreiIgna
Copy link

All this info is really useful, maybe can be added as Wiki pages here on GitHub so it's easier to find.

A few important things about using the functions framework were quite tricky to do, and found the info in closed issues..

@grant
Copy link
Contributor

grant commented Jun 24, 2019

@AndreiIgna Please link or re-open the issues if you think we should add them in docs.

@stew-r
Copy link
Contributor

stew-r commented Jun 24, 2019

@grant should we move your PR forward and make that a location for specialized and community docs contributions?

@grant
Copy link
Contributor

grant commented Jun 24, 2019

@stew-r Up to you. I think critical docs should be part of the repo, like how to configure a Dockerfile to use this module, should be in this repo rather than our community docs.

For example in @google/clasp, the docs/ folder is useful for advanced features not meant in the README and is maintained by the community.
https://github.com/google/clasp/tree/master/docs

@grant
Copy link
Contributor

grant commented Jun 27, 2019

@josephburnett Could you move the contents of this PR into the new docs/ folder? That'd be awesome.

@grant
Copy link
Contributor

grant commented Jul 9, 2019

@josephburnett Do you want to make the changes (move to docs/) or should I go ahead and make the doc change and close this PR?

@grant
Copy link
Contributor

grant commented Jul 19, 2019

FYI, I've created a PR that moves this change to the docs/ directory.

@grant grant closed this Aug 5, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants