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.

Sign up for GitHub

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

Jump to bottom

Sample API Usage page is a bit confusing #101

Closed
vaikas opened this issue Jan 4, 2019 · 3 comments
Closed

Sample API Usage page is a bit confusing #101

vaikas opened this issue Jan 4, 2019 · 3 comments
Labels
kind/doc Issues and pull requests for documentations

Comments

@vaikas
Copy link
Contributor

vaikas commented Jan 4, 2019

/kind doc

Expected Behavior

Sample API documentation that works

Actual Behavior

Sample API documentation page here:
https://github.com/knative/serving/blob/master/docs/spec/normative_examples.md#4-deploy-a-revision-from-source

talks about knative tool that doesn't exist and users find it confusing. It would seem clearer to update to use a kubectl example files rather than the tool itself.

Steps to Reproduce the Problem

  1. Bring up this page: https://github.com/knative/serving/blob/master/docs/spec/normative_examples.md#4-deploy-a-revision-from-source
  2. Though it mentions that these are samples for CLI it's a bit odd to talk about Sample API Usage and then demo it with a CLI tool that doesn't exist.

Additional Info
@mattmoor
Copy link
Member

We should consider moving this to the clients repo? cc @sixolet

@mattmoor mattmoor transferred this issue from knative/serving May 10, 2019
@maximilien
Copy link
Contributor

maximilien commented May 13, 2019 •
edited
Loading

I am also happy to submit a PR to the serving API docs to get it up to date with kn --- at least everywhere we can so far. Let me know preferred approach? Move all content to this repo as @mattmoor suggests or keep separate and fix. I am cool with either.

@sixolet sixolet added the kind/doc Issues and pull requests for documentations label Jul 11, 2019
coryrc pushed a commit to coryrc/client that referenced this issue May 14, 2020
@adrcunha @knative-prow-robot
Add a function to lint markdown files (knative#104)
9230115 
`run_lint_tool()` uses markdownlint as the lint tool.

Bonus: factor out running a linter against a set of files.

Part of knative#101.
coryrc pushed a commit to coryrc/client that referenced this issue May 14, 2020
@adrcunha @knative-prow-robot
Create a default integration test runner for presubmit (knative#199)
fc6f7ff 
* Scripts can customize the behavior by providing their own function, plus pre/post actions.

Part of knative#101.

Bonuses:
* moved documentation to README
* added basic tests for the feature
* moved the helper tests to a separate directory for clarity
* refactored checking if a function exists into a function
* test-infra presubmit now uses the default integration test runner

* Replace last instance of "type -t"

* Make custom flag smoke test a unit test

* Explain test objective
@rhuss
Copy link
Contributor

rhuss commented Sep 14, 2020

As https://github.com/knative/serving/blob/master/docs/spec/normative_examples.md has been replaced by a pointer to the knative client githup repo, I think we can close this issue. The examples that have been used included in this document will be moved more less over to the forthcoming user manual (#650)

btw, I think https://github.com/knative/serving/blob/master/docs/spec/normative_examples.md could be completely removed as it looks like that it is not referenced from anywhere

@rhuss rhuss closed this as completed Sep 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
kind/doc Issues and pull requests for documentations
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@maximilien @rhuss @sixolet @mattmoor @vaikas