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

ref tool steps + script #1008

Merged
merged 1 commit into from
Mar 16, 2019
Merged

ref tool steps + script #1008

merged 1 commit into from
Mar 16, 2019

Conversation

RichieEscarez
Copy link
Contributor

add "how to build knative api docs" steps while its front of mind

also included copy of changes/improvements to script from #998 and #1001

/cc @ahmetb

@googlebot googlebot added the cla: yes Indicates the PR's author has signed the CLA. label Mar 15, 2019
@knative-prow-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: 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

@knative-prow-robot knative-prow-robot added approved size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Mar 15, 2019
carieshmarie
carieshmarie reviewed Mar 15, 2019
View reviewed changes
Copy link
Contributor

@carieshmarie carieshmarie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggesting some minor changes.

docs/reference/README.md
1. Copy the generated API files into the `docs/reference` directory of your
knative/docs clone.

You can now perform the necessary steps to open a PR, complete a review, and
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be a step too?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i feel like these steps should be known if you are a "maintainer" but ive added a link to the info in the contributor docs

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Edits are here: #1010

@carieshmarie carieshmarie added the lgtm Indicates that a PR is ready to be merged. label Mar 16, 2019
@RichieEscarez RichieEscarez removed the lgtm Indicates that a PR is ready to be merged. label Mar 16, 2019
@knative-prow-robot knative-prow-robot merged commit ec533a1 into knative:release-0.3 Mar 16, 2019
@ahmetb
Copy link
Contributor

ahmetb commented Mar 16, 2019

I think audience of the generating API Docs steps is 3 orders of magnitude smaller than consumers. So please consider separating the instructions to another doc.

@RichieEscarez
Copy link
Contributor Author

RichieEscarez commented Mar 16, 2019 •
edited
Loading

I think audience of the generating API Docs steps is 3 orders of magnitude smaller than consumers. So please consider separating the instructions to another doc.

This file is only seen from the GitHub repo but I do agree that there should be some type of separate "maintainer" section for this type of info. For the time being, until we decide in general where that is, I'd like to come back to this at a later time. Opened this issue for tracking: #1009

Thanks! and keep all the great feedback coming!

RichieEscarez added a commit that referenced this pull request Mar 16, 2019
@RichieEscarez
Incorporate edits from #1008
6eadad7
@RichieEscarez RichieEscarez mentioned this pull request Mar 16, 2019
Merged
knative-prow-robot pushed a commit that referenced this pull request Mar 18, 2019
@RichieEscarez @knative-prow-robot
Incorporate edits from #1008 (#1010)
7a1eb5d 
* Incorporate edits from #1008

* Add "contributor" info link
RichieEscarez added a commit to RichieEscarez/docs that referenced this pull request Mar 19, 2019
@RichieEscarez
ref tool steps + script (knative#1008)
dc0ba42
RichieEscarez added a commit to RichieEscarez/docs that referenced this pull request Mar 19, 2019
@RichieEscarez
Incorporate edits from knative#1008 (knative#1010)
94fcd1b 
* Incorporate edits from knative#1008

* Add "contributor" info link
knative-prow-robot pushed a commit that referenced this pull request Mar 20, 2019
@RichieEscarez @knative-prow-robot
Merge website files into Master (#1025)
3c04f86 
* Add front matter to Build files (#833)

* Update README.md

* Adding front matter to builds.md

* Update installing-build-component.md

* Update README.md

Revert changes so Richie can handle this with the index file

* Update builder-contract.md

* Update personas.md

* Update auth.md

* Update creating-builds.md

* Update build-templates.md

* sentence case

* sentence case

* sentence case

* Adding frontmatter to /install/ (#834)

* Adds front matter to Serving (#838)

* Update accessing-logs.md

* Update accessing-metrics.md

* Update accessing-traces.md

* Update cluster-local-route.md

* Update debugging-application-issues.md

* Update debugging-performance-issues.md

* Update gke-assigning-static-ip-address.md

* Update installing-logging-metrics-traces.md

* Update outbound-network-access.md

* Update setting-up-a-logging-plugin.md

* Update using-a-custom-domain.md

* Update using-an-ssl-cert.md

* Update using-cert-manager-on-gcp.md

* Update using-external-dns-on-gcp.md

* site index for fluentd folder (#839)

* add Hugo index files and frontmatter (#840)

* hugo build files for autogen refdocs (#841)

* move resources and readme (#843)

* site: add blog (#837)

* add blog folder

* switch to sentence case

* site: add community and contributing (#836)

* add _index.md files and front matter

* switch to sentance case caps

* fix weights

* Update community/samples/README.md

Co-Authored-By: RichieEscarez <[email protected]>

* site: restructure content into a "docs" directory (#842)

* move content into a 'docs' directory

* inject additional 'docs' directory

* site: add build files and front matter to serving samples (#850)

* new _index.md files and front matter

* serving samples + fix urls

* remove file

* add PR#851 - channels (#853)

* Update README.md (#854)

* Remove README.md from all links (#855)

* Remove README.md from all links

* mend

* mend

* mend

* Update _index.md

* Update _index.md

* Update _index.md

* Update _index.md

* fix links in community (#857)

* Update _index.md (#856)

* Update _index.md

* Update _index.md

* Update _index.md

* Update _index.md

* Update _index.md

* Update _index.md

* Update _index.md

* Update _index.md

* Update _index.md

* Update _index.md

* Update _index.md

* Update _index.md

* Update _index.md

* Update _index.md

Adds missing pointer to README

* Update _index.md

* Update _index.md

* Update _index.md

* Update _index.md

* Update _index.md

* Update _index.md

* Update _index.md

* Update _index.md

* Update _index.md

* Update _index.md

* Update _index.md

* Update _index.md

* Update _index.md

* Update _index.md

* Update _index.md

* Update _index.md

* Update _index.md

* Update _index.md

* Update _index.md

* Update _index.md

* revert

* fix build links (#858)

* site: fix eventing links (#859)

* fix eventing links

* Update README.md

* fix install links (#860)

* site: fix serving links (#861)

* fix serving links

* Update using-external-dns-on-gcp.md

* remove hardcoded github link (#863)

* Update README.md (#864)

Fix links by removing md file extensions.

* Fix links (#866)

* Fix links

* Update installing-build-component.md

* Update builder-contract.md

* add missing hello-world directory (#865)

* Link fixes for Build (#867)

* Fix links

* Update installing-build-component.md

* Update builder-contract.md

* Update creating-builds.md

* Update builder-contract.md

* Update builds.md

* Update creating-builds.md

* Update installing-build-component.md

* Update installing-build-component.md

* Update creating-builds.md

* Update creating-builds.md

* Update builds.md

* Update build-templates.md

* convert to Hugo rel link

* Manually run prettier.io (#880)

* Manually run prettier.io

Trying to fix the stuff that hits prettier.io bugs.

* Fix prettier.io issues.

* Revert manual link fixes (use new build script instead) (#927)

* Revert "convert to Hugo rel link"

This reverts commit f1bbc8e.

* Revert "Fix links (#866)"

This reverts commit 3a57ffe.

* Revert "remove hardcoded github link (#863)"

This reverts commit fb7fdd9.

* Revert "site: fix serving links (#861)"

This reverts commit f61514c.

* Revert "fix install links (#860)"

This reverts commit 1fcf32b.

* Revert "site: fix eventing links (#859)"

This reverts commit 8809165.

* Revert "fix build links (#858)"

This reverts commit 847e08b.

* Revert "fix links in community (#857)"

This reverts commit 0cd5a44.

* Revert "Remove README.md from all links (#855)"

This reverts commit 2029c8b.

* Revert "Update README.md (#864)"

This reverts commit 072c731.

* Adding frontmatter to Gloo guide (#939)

*  adding frontmatter; cherry-picking commit into 0.3 (#943)

* Deploy using private registry (#847)

* new doc for deploying with private registry

* update last few steps

* header sizes

* capitalization

* updating with correct registry annotation and small edits

* wording

* formatting

* formatting

* Update serving/deploying-with-private-registry.md

Co-Authored-By: beemarie <[email protected]>

* Update serving/deploying-with-private-registry.md

Co-Authored-By: beemarie <[email protected]>

* Update serving/deploying-with-private-registry.md

Co-Authored-By: beemarie <[email protected]>

* Update serving/deploying-with-private-registry.md

Co-Authored-By: beemarie <[email protected]>

* Update serving/deploying-with-private-registry.md

Co-Authored-By: beemarie <[email protected]>

* update based on feedback

* missing <

* adding tic marks for filename

* udpate with helloworld-go sample

* add testing application

* update return from helloworld app

* update readme with link to doc

* Update serving/deploying-with-private-registry.md

Co-Authored-By: beemarie <[email protected]>

* Update serving/deploying-with-private-registry.md

Co-Authored-By: beemarie <[email protected]>

* Update serving/deploying-with-private-registry.md

Co-Authored-By: beemarie <[email protected]>

* Update serving/deploying-with-private-registry.md

Co-Authored-By: beemarie <[email protected]>

* Update serving/deploying-with-private-registry.md

Co-Authored-By: beemarie <[email protected]>

* adding frontmatter; cherry-picking commit into 0.3

* Update Knative-with-Minishift.md (#988)

Update to correct title (Openshift > Minishift), as mentioned by Ashleigh in the Docs WG.

* add type:docs + enable relative links (#990)

* Deleting an unnecessary file

accidentally copied in extra file

* update ref docs api build script and files (#997)

* all links must have ./ (#1004)

* all links must have ./

* Update contributing/README.md

Co-Authored-By: RichieEscarez <[email protected]>

* Update contributing/README.md

Co-Authored-By: RichieEscarez <[email protected]>

* Update for clarity

* Update README.md

Fixing my poorly formatting suggestion

* ref tool steps + script (#1008)

* Incorporate edits from #1008 (#1010)

* Incorporate edits from #1008

* Add "contributor" info link

* page-by-page link check fixes (#1024)

* update readmes - source and site versions

* rename file to fix left nav

* rename file and remove folder to fix left nav
@RichieEscarez RichieEscarez deleted the reftoolsteps branch April 12, 2019 17:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@carieshmarie carieshmarie carieshmarie left review comments

@ahmetb ahmetb Awaiting requested review from ahmetb

Assignees

@samodell samodell

Labels
cla: yes Indicates the PR's author has signed the CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@RichieEscarez @knative-prow-robot @ahmetb @carieshmarie @googlebot @samodell