Skip to content

api-reference: Add API reference docs #714

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
Merged
merged 1 commit into from
Jan 8, 2019
Merged

api-reference: Add API reference docs #714

merged 1 commit into from
Jan 8, 2019

Conversation

@ahmetb
Copy link
Contributor

@ahmetb ahmetb commented Jan 7, 2019

Generated with https://github.com/ahmetb/gen-crd-api-reference-docs and
this patch includes the script to self-serve this process. I hope to improve
this stuff in the future, for now it works fine.

Fixes #636.

@knative-prow-robot knative-prow-robot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Jan 7, 2019
@ahmetb
Copy link
Contributor Author

ahmetb commented Jan 7, 2019

/assign @RichieEscarez

@RichieEscarez
Copy link
Contributor

RichieEscarez commented Jan 8, 2019

The script looks like it correctly targets the new "reference" directory but the PR currently uses api-reference as the file path for all files. Can you please rename (api-reference -> reference)?
I think its okay for the script/tool to reside elsewhere (if its coded to work that way)? I see that the other repos use a "hack" folder for their tools, maybe we follow that structure too? Otherwise if the script lives in "reference" that works for me too.

Thanks @ahmetb these files and the tool are great!

@ahmetb
Copy link
Contributor Author

ahmetb commented Jan 8, 2019

I'll rename to reference.

I'll add the scripts to hack/.

@ahmetb
api-reference: Add API reference docs
a59d34a 
Generated with https://github.com/ahmetb/gen-crd-api-reference-docs and
this patch includes the script to self-serve this process. I hope to improve
this stuff in the future, for now it works fine.

Fixes knative#636.

Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com>
@ahmetb
Copy link
Contributor Author

ahmetb commented Jan 8, 2019

done. PTAL

@RichieEscarez
Copy link
Contributor

RichieEscarez commented Jan 8, 2019

That was quick! This is such a great docs improvement, thanks again @ahmetb !

/lgtm

/approve

@knative-prow-robot knative-prow-robot added the lgtm Indicates that a PR is ready to be merged. label Jan 8, 2019
@knative-prow-robot
Copy link
Contributor

knative-prow-robot commented Jan 8, 2019

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ahmetb, RichieEscarez

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ahmetb
Copy link
Contributor Author

ahmetb commented Jan 8, 2019

/retest

@ahmetb ahmetb mentioned this pull request Jan 8, 2019
Closed
@knative-prow-robot knative-prow-robot merged commit df7c2b5 into knative:master Jan 8, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@carieshmarie carieshmarie Awaiting requested review from carieshmarie

@samodell samodell Awaiting requested review from samodell

Assignees

@RichieEscarez RichieEscarez

Labels

lgtm Indicates that a PR is ready to be merged. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@ahmetb @RichieEscarez @knative-prow-robot