* Update and reorganise kn cli setup docs
* fix grammar
Co-authored-by: David Simansky <dsimansk@redhat.com>
* restore docs/README.md with selective content
* Update user guide link to point to official website
Co-authored-by: David Simansky <dsimansk@redhat.com>
---------
Co-authored-by: David Simansky <dsimansk@redhat.com>
* chore: Cleaned up README
This is just a start for reorganizing the client side documentation.
* fix: link
* chore(README): Fix link
* chore: fixed link
* review fixes
* minor wording
* Check that every generated file has been regenerated for CI
* No color when not on a tty which is useful for build logs
* Always do updates when called without args
* Removed -u option and added -c for codegen only (dep update, docs gen, formatting, license check)
* it will make easy to access docs from single directory, it will also help in case if we create github pages for the same
* fixed links from README.md
rebased and addressed comments
This features uses and requires https://github.com/AgentCosmic/xnotify
and should work on any platform
Use it with
* Watch & compile: build.sh --watch
* Watch, compile, test: build.sh --watch --test
* Watch, compile, test & verbose output: build.sh --watch --test --verbose
(shortcuts -w && -t can be used, too)
* feat(build.sh): Adding options and running tests
* Added running unit tests to the script
* Added options to support different development flows (see help message below)
* Allow symlinking to /usr/local/bin so that the script can be called from everywhere
Usage message:
Knative Client Build Script
Usage: hack/build.sh [... options ...]
with the following options:
-f --fast Only build (without formatting, testing, code generation)
-t --test Run tests even when used with --fast
-u --update Update dependencies
-h --help Display this help message
--verbose Verbose script output (set -x)
You can add a symbolic link to this build script into your PATH so that it can be
called from everywhere. E.g.:
ln -s .../hack/build.sh /usr/local/bin/kn_build.sh
Examples:
* Compile, format, tests, docs: build.sh
* Compile only: build.sh --fast
* Compile with tests: build.sh -f -t
* doc(build.sh): Added documentation for new build.sh options
* docs(build.sh): Cosmetic fixes
* docs(build.sh): Tiny documentation fix
* chore(build.sh): Another typo fix
* Adds DEVELOPMENT.md
Fixes#26
Also adds CONTRIBUTING.md which points to knative/docs.
* Links DEVELOPMENT.md with README.md
- also removes the build steps as those are now part of DEVELOPMENT.md
- links the install guide to www.knative.dev/docs/install/
- removes unnecessary GOPATH setup steps
- removes CONTRIBUTING.md as its linked from README.md now
- links all references for contribution guide to https://www.knative.dev/contributing/
* Updates the repo fork step and removes unnecessary heading
Joy Paul