* add gh-action to deploy mkdocs to gh-pages
* update commit user for gh-pages
Signed-off-by: Carlos Santana <csantana23@gmail.com>
* switch to fast livereload
Signed-off-by: Carlos Santana <csantana23@gmail.com>
* initial move over
* Fix up index page names
* Add version variables
* Escape macro syntax
* Automatic fixups with mkhugo
* Drop no-longer-needed excludes
* Rename more _index files
* Move broker-configmaps.md a README.md
avoids a directory with no index/readme
* Autogenerate Eventing nav
* Fix markdown
* Update Serving nav
* Add h1 headers
Makes things look nicer in github, and makes search work more accurately
in mkdocs
* Unexclude all samples
* Correct client link
* Fix gitignore, skip hugo tests
* Update api doc config
Duck no longer lives in github.com/knative, and networking package has
been introduced. Also fill in a couple other packages to remove warnings
when run
* Regenerate api references
* 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>
* 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>
* 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
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>
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>
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>
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>
Addresses #66.
Addresses #67.
* Update test-infra to use the default build/unit test runners, which includes building go code and linting markdown files.
* Remove the integration tests, as they only start Knative Serving, which is irrelevant for this repo.
Bonuses:
* fix unbuildable `grpc-ping-go` sample
* remove test-infra import hack from `Gopack.lock` and `update-deps.sh`
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>
Includes:
* fixes to `library.sh` in order to have some `hack` scripts working again;
* better checking of PRs where presubmit tests are unnecessary;
Bonus: adds the missing eXecution bit to `update-deps.sh`.
* shared scripts from test-infra live in //vendor/github.com/knative/test-infra/scripts;
* created `//hack/update-deps.sh` to properly update deps, including test-infra;
* all bash scripts were updated to use the vendored scripts;
Part of knative/test-infra#30.