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
Samples do not instruct to clone code #1045
Comments
I think the helloworld samples were written with the idea that you'd copy and paste from the doc. The other samples however definitely had that expectation. |
This step does seem to exist for https://github.com/knative/docs/blob/master/docs/serving/samples/autoscale-go/README.md#prerequisites ? |
I'm happy to work on this? |
That'd be great, @mhamwala ! |
Going to submit separate PR's for each component just to make it easier to review, I believe these are all the samples in Serving that need the extra clone instruction step ^ |
#1203 fixes 0.6 (and since it specifically refers to "release-0.6" it cannot be directly cherry-picked to 0.5 as originally intended) |
Status update:
Related: #1409 - Stop copying all code into README files and instead "include" a copy of the corresponding file (during website build) |
With the content rendered in the website, we are now missing links or instructions about how to download the code source (or even view it).
We need to add a "Before you begin" section, or just ensure that there are instructions about how to clone the code from the repo so that its locally available.
Previously, all the sample readme's are written with the assumption that you are viewing them from the repo.
The text was updated successfully, but these errors were encountered: