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

Samples do not instruct to clone code #1045

Closed
RichieEscarez opened this issue Mar 21, 2019 · 7 comments
Closed

Samples do not instruct to clone code #1045

RichieEscarez opened this issue Mar 21, 2019 · 7 comments
Labels
kind/bug Categorizes issue or PR as related to a bug. kind/eventing

Comments

@RichieEscarez
Copy link
Contributor

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.

@RichieEscarez RichieEscarez added the kind/bug Categorizes issue or PR as related to a bug. label Mar 21, 2019
@rgregg
Copy link
Contributor

rgregg commented Mar 21, 2019

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.

@abrennan89
Copy link
Contributor

This step does seem to exist for https://github.com/knative/docs/blob/master/docs/serving/samples/autoscale-go/README.md#prerequisites ?
Can we add a list of specific samples or docs this is missing from?

@mhamwala
Copy link
Contributor

mhamwala commented Apr 17, 2019

I'm happy to work on this?

@samodell
Copy link
Contributor

That'd be great, @mhamwala !

@mhamwala
Copy link
Contributor

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 ^

@RichieEscarez
Copy link
Contributor Author

#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)

@RichieEscarez
Copy link
Contributor Author

RichieEscarez commented Jun 6, 2019

Status update:
Other areas need to be investigated and instruction and links need to be added:

Related: #1409 - Stop copying all code into README files and instead "include" a copy of the corresponding file (during website build)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Categorizes issue or PR as related to a bug. kind/eventing
Projects
No open projects
Development

No branches or pull requests

6 participants