Ville Aikas
f166c16ead
Fix issue 3489 (update docs after tools move from eventing-contrib repo to eventing repo) ( #3492 )
...
* checkpoint if I get the seds wrong
* remove cruft
* moar
* that should be it
2021-04-27 12:37:53 -07:00
Dave Protasowski
3399681e4b
Rebase of 3147 ( #3188 )
...
* Update serving.md
Saving some work....
* Update serving.md
Fixes #3143
* Update serving.md
fixed linting issues
* turn omer's changes into a patch
* re-run api gen
Co-authored-by: Omer B <obensaadon@vmware.com>
2021-01-25 10:35:55 -08:00
Ahmet Alp Balkan
b9d547a641
update gen-api-reference-docs script ( #3173 )
...
* update gen-api-reference-docs script
Updating the tool version to v0.3.0 tag.
Ran locally against v0.20.0 tag for serving/eventing repos, seems to be
working fine.
Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com>
* re-run api reference docs generation
Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com>
2021-01-19 17:05:53 -08:00
RichieEscarez
0816a3ca90
Knative API docs for v0.20.0 ( #3141 )
...
* update API docs for v0.20.0
* remove whitespace -> happy linter
2021-01-13 12:01:20 -08:00
RichieEscarez
40776cc069
Update API build and generate 0.19 API docs ( #3043 )
...
* remove eventing-contrib
* update gen-crd-api-reference-docs version to fix API build errors
* API docs build for 0.19
* revert API version and add troubleshooting docs
* revert file
* remove whitespace
* Update docs/reference/api/README.md
Co-authored-by: Mike Petersen <mike.petersen@ibm.com>
* add more detail
* and now fix my typo
Co-authored-by: Mike Petersen <mike.petersen@ibm.com>
2020-11-18 14:39:52 -08:00
Ben Browning
73b89aec62
Adjust API reference docs scripts for knative.dev ( #2054 )
...
* Adjust API reference docs scripts for knative.dev
The API reference docs were failing to generate because they didn't
account for the change from github.com/knative/serving to
knative.dev/serving and similar for the eventing and eventing-contrib
repos.
* change to _IMPORT_PATH
2019-12-16 19:49:02 -08:00
RichieEscarez
1397e226d3
eventing-contrib API and consistent file names ( #1805 )
2019-09-19 13:05:01 -07:00
RichieEscarez
4f76b5e60c
partial build and updated api scripts for v0.8 ( #1662 )
2019-08-08 16:13:59 -07:00
RichieEscarez
e1a90c498b
remove knative build from everywhere ( #1656 )
2019-08-08 08:42:56 -07:00
Ahmet Alp Balkan
56586dbb26
reference: fix api grouping in reference docs ( #1561 )
...
This bumps the `gen-crd-api-reference-docs` to v0.1.5 which has two notable
fixes impacting Knative:
1. Prevent types in same apiGroup but different apiVersion (e.g v1beta1 vs
v1alpha1) from grouped together.
2. De-duplicate the apiGroups list when types belonging to that api group come
from different Go packages.
Fixes #1559 .
Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com>
2019-07-01 13:10:19 -07:00
Ahmet Alp Balkan
eb734da7cb
gen-api-reference-docs: fixes for eventing-contrib ( #1552 )
...
This updates to a recent version of gen-crd-api-reference-docs and allows
customizing the -api-dir option so that the docs for theeventing-contrib repo
can be generated.
Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com>
2019-06-28 15:17:07 -07:00
RichieEscarez
75c6e88fa8
Clarify "event sources" NOT "Knative eventing sources" ( #1535 )
...
* clarify eventing resources (not just sources)
* Update docs/eventing/debugging/README.md
Co-Authored-By: Sam O'Dell <31352624+samodell@users.noreply.github.com>
2019-06-26 15:32:06 -07:00
Scott Nichols
7de9fe79f4
rename knative/eventing-sources to knative/eventing-contrib ( #1433 )
...
* rename knative/eventing-sources to knative/eventing-contrib
* revert gcr.io rename until next release.
2019-06-17 16:27:46 -07:00
RichieEscarez
3c04f86ad7
Merge website files into Master ( #1025 )
...
* 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 <rescarez@google.com>
* 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 f1bbc8ebbc
.
* Revert "Fix links (#866 )"
This reverts commit 3a57ffed62
.
* Revert "remove hardcoded github link (#863 )"
This reverts commit fb7fdd9383
.
* Revert "site: fix serving links (#861 )"
This reverts commit f61514c1b4
.
* Revert "fix install links (#860 )"
This reverts commit 1fcf32b509
.
* Revert "site: fix eventing links (#859 )"
This reverts commit 880916567e
.
* Revert "fix build links (#858 )"
This reverts commit 847e08bf2e
.
* Revert "fix links in community (#857 )"
This reverts commit 0cd5a44baf
.
* Revert "Remove README.md from all links (#855 )"
This reverts commit 2029c8bccb
.
* Revert "Update README.md (#864 )"
This reverts commit 072c731155
.
* 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 <beemarie@us.ibm.com>
* Update serving/deploying-with-private-registry.md
Co-Authored-By: beemarie <beemarie@us.ibm.com>
* Update serving/deploying-with-private-registry.md
Co-Authored-By: beemarie <beemarie@us.ibm.com>
* Update serving/deploying-with-private-registry.md
Co-Authored-By: beemarie <beemarie@us.ibm.com>
* Update serving/deploying-with-private-registry.md
Co-Authored-By: beemarie <beemarie@us.ibm.com>
* 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 <beemarie@us.ibm.com>
* Update serving/deploying-with-private-registry.md
Co-Authored-By: beemarie <beemarie@us.ibm.com>
* Update serving/deploying-with-private-registry.md
Co-Authored-By: beemarie <beemarie@us.ibm.com>
* Update serving/deploying-with-private-registry.md
Co-Authored-By: beemarie <beemarie@us.ibm.com>
* Update serving/deploying-with-private-registry.md
Co-Authored-By: beemarie <beemarie@us.ibm.com>
* 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 <rescarez@google.com>
* Update contributing/README.md
Co-Authored-By: RichieEscarez <rescarez@google.com>
* 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
2019-03-20 13:48:47 -07:00
Ahmet Alp Balkan
0b7f8ff519
hack: update ref docs gen script to cleanup tmp dirs ( #1001 )
...
Adding an EXIT trap to cleanup the /tmp directories containing
1. cloned knative repos (can be huge, especially going forward)
2. `gen-crd-api-reference-docs` tool's repo + built binary
Fixes #1000 .
Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com>
2019-03-15 14:03:44 -07:00
Ahmet Alp Balkan
3a0241929d
hack: configurable repo refs for api docs gen ( #998 )
...
The API docs generation script can now be called with non-hardcoded commit/tag
refs.
KNATIVE_SERVING_COMMIT=v0.4.0 \
KNATIVE_BUILD_COMMIT=v0.4.0 \
KNATIVE_EVENTING_COMMIT=v0.2.1 \
KNATIVE_EVENTING_SOURCES_COMMIT=v0.2.1 ./gen-api-reference-docs.sh
This should ease docs releases a tiny bit.
Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com>
2019-03-15 13:51:44 -07:00
Ahmet Alp Balkan
df7c2b5dff
api-reference: Add API reference docs ( #714 )
...
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 .
Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com>
2019-01-08 12:45:41 -08:00