Commit Graph

74 Commits

Author SHA1 Message Date
Caleb Woodbine ac6b067b02
docs: update instructions on client code-sign verification (#5610)
* docs: update instructions on client code sign verification

* docs: update cosign keyless references
2023-07-31 08:18:59 +00:00
Lance Ball 1ced7de036
fix: correct bad link to reference page (#5482)
Also adds Knative Functions to the releases page.

Signed-off-by: Lance Ball <lball@redhat.com>
2023-03-16 18:08:59 +00:00
Mahamed 788eb6c165
Add image/binary signing verification docs (#5272)
* add image signing instructions

* move signing to separate snippets

* fix lint error

* remove the snippets properly

* Apply suggestions from code review

Co-authored-by: Ashleigh Brennan <abrennan@redhat.com>

* bump versions to 1.9

* break out the steps

* add feature to the blogs

---------

Co-authored-by: Ashleigh Brennan <abrennan@redhat.com>
2023-02-07 19:42:47 +00:00
Andrew Su cfd3a205d0
chore: update security report detail (#5326)
Fixed a typo and updated the email to be a `mailto` link.
2022-11-16 16:36:40 +00:00
Ashleigh Brennan 2c8f9e3af6
Create Concepts section (#5155)
* Create Concepts section

* add redirect

* remove broken links

* remove broken links

* add new tab to links

* add new tab to links
2022-07-29 15:51:41 +00:00
Ashleigh Brennan aa99afea2c
General cleanup of sample and ref docs (#5117)
* General cleanup of sample and ref docs

* move reference docs

* fix nav and links

* update redirects

* fix comment

* added Paul's script updates, updating ext versions
2022-07-20 15:00:01 +00:00
Paul Schweigert e6059234e7
Adds security page to site (#4807)
* adds security page to site

Signed-off-by: Paul S. Schweigert <paulschw@us.ibm.com>

* remove whitespace

Signed-off-by: Paul S. Schweigert <paulschw@us.ibm.com>
2022-03-04 13:08:37 -08:00
Paul Schweigert e9713b12e1
Build client docs (#4623)
* build kn docs

* navigation tweaks

* link to github version of kn docs

* removing unneeded envvar

* removing go

* style
2022-01-13 05:00:12 -08:00
Samia Nneji 96b59e500d
Reorg Serving and Eventing files (#4396)
* Move eventing and serving topics

* Remove developer folder

* Remove admin folder

* Cleaning up
2021-10-29 00:46:53 -07:00
Christoph Jerolimov f56be1ba27
Fix operator link on Knative release notes page (#4327)
Fix link on https://knative.dev/docs/reference/relnotes/ and replace archived serving-operator link with operator link.
2021-10-06 06:41:45 -07:00
Ashleigh Brennan f95fdef486
Remove outdated YAML for Hugo (#4114) 2021-08-16 12:28:55 -07:00
Julian Friedman 40a792a1e1
Pull in api docs in build (#3832) 2021-06-22 16:08:44 -07:00
Omer B 5e56c88e45
Issue 3642 finishing up eventing sanity check (#3743)
* Update mkdocs.yml

* Update mkdocs.yml

* Update mkdocs.yml

* bringing back the purple

* Revert "bringing back the purple"

This reverts commit a6af055288.

* Removing reference to GKE-specific docs

* bash, resolving redirect warning for help

* replace all shells with bash across the entire project

* style guide conformance

* index -> readme

* serving link fixes while I'm at it

* fix serving links and redirects

* lint
2021-06-08 05:53:41 -07:00
Omer B e2749dac0f
rebasing `main` on `mkdocs` pt2 (#3621)
* change name for menu item for preview (#3533)

Signed-off-by: Carlos Santana <csantana23@gmail.com>

* Added detail per issue #3425 (#3514)

* Update knative/community files (#3553)

Signed-off-by: Knative Automation <automation@knative.team>

* tracing cm fix (#3506)

* remove unnecessary requrirements to do a release (#3563)

Signed-off-by: Carlos Santana <csantana23@gmail.com>

* #3543 fix link (#3567)

* Replace xip.io with sslip.io (#3574)

* Update actions (#3535)

Signed-off-by: Knative Automation <automation@knative.team>

* Update common github actions (#3552)

Signed-off-by: Knative Automation <automation@knative.team>

* upgrade to latest dependencies (#3505)

bumping knative.dev/hack 88c69cd...93ad912:
  > 93ad912 Print java and mvn version (# 65)
  > 86f9adc Fix default codegen pkg dir (# 67)

Signed-off-by: Knative Automation <automation@knative.team>

* Remove responsive-revision-gc config (#3545)

Since https://github.com/knative/serving/pull/10084 deleted old GC and
started using responsive GC by default, `responsive-revision-gc` in
`config-feature` is not used at all.

This patch removes the configuration `responsive-revision-gc` in
`config-feature` configmap.

* Fixes #3117 and broken links (#3569)

* Fix #3117 and broken links

* Fix #3117 and broken links

* remove spec folder and redirect page and update links

* remove conflicts

* Update shortcodes.md (#3550)

minor grammar.

* 💄 slight change to ordered delivery guarantees (#3536)

Signed-off-by: Matthias Wessendorf <mwessend@redhat.com>

* Add knative-release-leads to OWNERS (#3586)

* add approvers ux (#3587)

* Update the default value (#3530)

* Adding notes on KafkaSource usage (#3596)

* Adding some Kafka note for use-cases

Signed-off-by: Matthias Wessendorf <mwessend@redhat.com>

* changing the description

Signed-off-by: Matthias Wessendorf <mwessend@redhat.com>

* Update actions (#3581)

Signed-off-by: Knative Automation <automation@knative.team>

* Remove python pycache (#3594)

* Use correct setting in ClusterIssue setting (#3595)

The doc uses ClusterIssuer `letsencrypt-http01-issuer` but the configuration uses
`letsencrypt-issuer` so it is confusable.
Actual report is https://github.com/knative/docs/issues/3560.

So this patch changes the ClusterIssuer name to
`letsencrypt-http01-issuer` which is used in this doc section.

Fix https://github.com/knative/docs/issues/3560

* fix broken link #3568 #3577 (#3579)

* fix Netlify build

* Added Snippets folder and hidden Beta Contributor guide

* Update docs/eventing/event-registry.md

Co-authored-by: Carlos Santana <csantana23@gmail.com>

* whitespace

* more whitespace

* removing this bit because linting is killing me

* ok really the last one

* Updating to latest API version of Strimzi. v1beta1 is now gone 🔥 (#3603)

Signed-off-by: Matthias Wessendorf <mwessend@redhat.com>

* 📓 adding a note to not consume records of the kafkachannel's topic... (#3615)

Signed-off-by: Matthias Wessendorf <mwessend@redhat.com>

* fix broken link in kogito example (#3602)

* docs about usage of internal services in an "api-gateway" access model (#3597)

Co-authored-by: Brüder, Lena <lena.brueder@maxxeed.com>

* api specs for v0.23 (#3619)

Signed-off-by: Carlos Santana <csantana23@gmail.com>

* Update serving/_index.md with network layer option (#3585)

* Update _index.md

[#3117] Add ref for contour

* Update docs/serving/_index.md

Co-authored-by: Ashleigh Brennan <abrennan@redhat.com>

Co-authored-by: Omer B <obensaadon@vmware.com>
Co-authored-by: Ashleigh Brennan <abrennan@redhat.com>

* Fix typos in the sample yaml file (#3616)

* EventType is not yet part of the v1 eventing API (#3576)

* Remaining changes from now closed PRs

Co-authored-by: Carlos Santana <csantana23@gmail.com>
Co-authored-by: RichardJJG <rijohnson@vmware.com>
Co-authored-by: knative-automation <automation@knative.team>
Co-authored-by: Shashankft9 <48708039+Shashankft9@users.noreply.github.com>
Co-authored-by: Ashleigh Brennan <abrennan@redhat.com>
Co-authored-by: Benjamin Tan Wei Hao <benjamintanweihao@gmail.com>
Co-authored-by: Kenjiro Nakayama <nakayamakenjiro@gmail.com>
Co-authored-by: Jonathan Johnson <jonathan.johnson@dijure.com>
Co-authored-by: Matthias Wessendorf <mwessend@redhat.com>
Co-authored-by: Evan Anderson <evana@vmware.com>
Co-authored-by: RichieEscarez <rescarez@google.com>
Co-authored-by: NovaHe <heqianfly@gmail.com>
Co-authored-by: Kevin Marquardsen <mr.kmarq@gmail.com>
Co-authored-by: Lena Brüder <oss@lena-brueder.de>
Co-authored-by: Brüder, Lena <lena.brueder@maxxeed.com>
Co-authored-by: Sameer Vohra <vsameer@vmware.com>
Co-authored-by: Mahdi K. Fard <xclud@users.noreply.github.com>
2021-05-19 12:56:16 -07:00
Julian Friedman 61b8c3f91e
Move mkdocs work over from julz/mkdocs branch (#3551)
* 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
2021-05-11 05:58:46 -07:00
RichieEscarez 3af9db6781
Consolidate all "docs" help info into single location (#3437)
* consolidate docs how-to guides

* fix template linking

* consolidate and organize

* update links

* fix link

* fix typos

and
offensive term

* Update help/contributor/how-to/formatting.md

Co-authored-by: Samia Nneji <snneji@vmware.com>

* Update help/contributor/how-to/formatting.md

Co-authored-by: Samia Nneji <snneji@vmware.com>

* Update help/contributor/gettingstarted.md

Co-authored-by: Samia Nneji <snneji@vmware.com>

* Update help/faqs.md

Co-authored-by: Samia Nneji <snneji@vmware.com>

* Update help/contributor/publishing.md

Co-authored-by: Samia Nneji <snneji@vmware.com>

* Update help/contributor/publishing.md

Co-authored-by: Samia Nneji <snneji@vmware.com>

* recover review comments

* typo

Co-authored-by: Samia Nneji <snneji@vmware.com>
2021-04-26 10:57:40 -07:00
Julian Friedman 1002b9c1b0
Fix API doc generator to properly link to duck, networking (#3479)
* 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
2021-04-19 15:08:00 -07:00
Omer B ea26207311
Releasing v0.22.0 (#3426) 2021-04-06 11:28:38 -07:00
Markus Thömmes c8b51931ed
Drop unnecessary occurrences of master (#3333) 2021-03-11 05:08:26 -08:00
Ashleigh Brennan 2055f181ac
Clean up and add to CLI docs (#3302)
* Clean up and add to CLI docs

* updates from SME review

* updates from SME review
2021-03-05 06:45:20 -08:00
Evan Anderson 74c867bbf5
New contrib (#3269)
* Moving to asciidoc

* Rewrite contributor documentation

* Emphasize tech writers expertise rather than ascribing motivations to engineers.

Co-authored-by: Scott Nichols <snichols@vmware.com>

* Address @omerbensaadon feedback

* Address @omerbensaadon feedback

* Revert to markdown

* Dumbquotify

* Update CONTRIBUTING.md

Co-authored-by: RichieEscarez <rescarez@google.com>

* Update CONTRIBUTING.md

Co-authored-by: RichieEscarez <rescarez@google.com>

* Update two refs to DOCS-CONTRIBUTING to point to the main contributor docs

Co-authored-by: Scott Nichols <snichols@vmware.com>
Co-authored-by: RichieEscarez <rescarez@google.com>
2021-02-26 12:19:47 -08:00
Carlos Santana ff041e52f5
Knative API docs for v0.21.0 (#3276) 2021-02-24 12:09:47 -08: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
Evan Anderson 194f542067
Update calendar and drive links (#3127)
* Update calendar and drive links

* Switch link to web published version
2021-01-12 06:23:30 -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
Dave Protasowski 139b047371
drop serving v1beta1 and v1alpha1 APIs (#2887)
* drop v1beta1 and v1alpha1

* api doc should reference v1 API

* drop v1alpha1 manually
2020-10-13 08:29:30 -07:00
RichieEscarez cf4781ecdc
API docs for 0.18 docs release (#2867)
* API build for 0.18 serving and eventing

* fix for ref docs restructure

* add eventing-contrib and auto trim whitespace

* manually remove whitespace and add that to the instructions

* fix nav ordering

* remove whitespace
2020-09-30 13:38:29 -07:00
Ashleigh Brennan e6d96d0a52
Update reference section as per #1883 (#2806)
* Update reference section as per #1883

* fix link

* update folder name

* fixed links and peer review feedback

* added aliases

* added aliases

* removed unnecessary heading

* removed kn section

* updated heading and position of optional stuff

* fix note
2020-09-23 11:19:40 -07:00
RichieEscarez ee28750789
build API docs for 0.17 (#2763)
* build API docs for 0.17

* Update docs/reference/serving.md

Co-authored-by: Matt Moore <mattmoor@vmware.com>

* Update docs/reference/serving.md

Co-authored-by: Matt Moore <mattmoor@vmware.com>

* Update docs/reference/serving.md

Co-authored-by: Matt Moore <mattmoor@vmware.com>

* Update docs/reference/serving.md

Co-authored-by: Matt Moore <mattmoor@vmware.com>

* Update docs/reference/serving.md

Co-authored-by: Matt Moore <mattmoor@vmware.com>

* Update docs/reference/serving.md

Co-authored-by: Matt Moore <mattmoor@vmware.com>

* Update docs/reference/serving.md

Co-authored-by: Matt Moore <mattmoor@vmware.com>

* Update docs/reference/serving.md

Co-authored-by: Matt Moore <mattmoor@vmware.com>

Co-authored-by: Matt Moore <mattmoor@vmware.com>
2020-08-20 11:42:14 -07:00
ellenevans e5f1984104
updated api docs for v0.16.0 (#2656)
* updated api docs for v0.16.0

* Update docs/reference/serving.md

Co-authored-by: Matt Moore <mattmoor@vmware.com>

Co-authored-by: Matt Moore <mattmoor@vmware.com>
2020-07-08 12:25:07 -07:00
Ville Aikas 9db70796af
change all previous versions to generated/kubernetes-api/v1.18 (#2567) 2020-06-09 14:39:32 -07:00
ellenevans 5458bef4d4
updated api docs (#2517)
* updated api docs

* fixed bad links in api docs

* refix links

* endless update of URLs

* I wish someone would update the source for this
2020-06-02 19:53:17 -07:00
savitaashture a7b085466e
Update Docs to include new field called ContainerStatus in the revision status (#2405) 2020-04-29 15:56:42 -07:00
ellenevans cc6d24a274
Updated APIs for v0.14.0 release (#2391)
* Updated APIs for v0.14.0 release

* Update docs/reference/eventing/eventing-contrib.md

Co-Authored-By: Matt Moore <mattmoor@vmware.com>

* Updated faulty links.

* Update links in serving.md

* trying to fix samples link in GitLab

* Still trying the update

* Update docs/reference/eventing/eventing-contrib.md

Co-Authored-By: Matt Moore <mattmoor@vmware.com>

Co-authored-by: Matt Moore <mattmoor@vmware.com>
2020-04-20 16:43:50 -07:00
ellenevans 04ea875ab1
Updated link to contributor doc because broken (#2322)
Should be https://github.com/knative/community/blob/master/docs/DOCS-CONTRIBUTING.md
2020-03-20 09:07:08 -07:00
Knative Prow Robot 41bbe4b5b0
Updated Serving API docs for 0.13.0 (#2271)
* Updated docs for eventing 0.13.0

* Adding updated eventing.md file for v0.13.0

* Add Serving API docs 0.13.0

* Adding Serving API docs for 0.13.0

* Update docs/reference/eventing/eventing-contrib.md

Co-Authored-By: Matt Moore <mattmoor@vmware.com>

Co-authored-by: Matt Moore <mattmoor@vmware.com>
2020-03-04 10:58:54 -08:00
ellenevans 2b5a3889eb
Eventing API docs for v0.13.0 (#2268)
* Updated docs for eventing 0.13.0

* Adding updated eventing.md file for v0.13.0

* Update docs/reference/eventing/eventing-contrib.md

Co-Authored-By: Matt Moore <mattmoor@vmware.com>

Co-authored-by: Matt Moore <mattmoor@vmware.com>
2020-03-03 16:59:53 -08:00
Ashleigh Brennan 9c5258ec26
Added section for connecting to a cluster (#2047) 2020-02-18 11:25:58 -08:00
Matthias Wessendorf 3061eacada
Godoc seem dead 🙀 (#2201) 2020-02-11 07:22:09 -08:00
RichieEscarez 7f3b455ae4
Move Contributing to sub-dir of knative.dev/community (#2086)
* move contrib to community

* use fully qualified knative/community repo urls
2020-01-30 10:36:28 -08:00
Sam O'Dell 292d0050fe Reference docs 0.12 (#2117)
* v0.12 ref docs

* mend
2020-01-21 16:23:23 -08:00
Sam O'Dell a6773bcd62 removing directory temporarily to publish release today (#2115) 2020-01-21 12:48:23 -08:00
Ashleigh Brennan 4b81292454 Added instructions for installing kn (#2045) 2020-01-21 11:31:23 -08:00
Zhimin Xiang 4d7e1db99e Bump the min k8s version to 1.15 (#2091)
* Bump the min k8s version to 1.15

* add mising docs
2020-01-09 16:32:55 -08:00
Ben Browning 01fd1b3a3a v0.11.0 serving, eventing, eventing-contrib API reference docs (#2055)
* v0.11.0 serving, eventing, eventing-contrib API reference docs

* Update the broken generated knative.dev links

This commit is entirely generated by running the following command on
top of the generated Serving docs:

sed -i 's@https://knative.dev/serving@https://github.com/knative/serving@g' $(find -name '*.md' | xargs grep knative.dev/serving | cut -d':' -f 1 | uniq)
2019-12-16 20:06:02 -08:00
RichieEscarez a446321306 404 Fixes and Cherry-picks from 0.10 (#2048)
* Secrets use GOOGLE_APPLICATION_CREDENTIALS as key (#1769)

* [DOC] Add alternative shell command to delete knative service  (#1727)

* Update getting-started-knative-app.md

It is very useful when `kservice` are created via API and not with files.

* Delete the word "record" per review.

* Fix typo in microk8s doc (#1912)

* Fix the Subscription's apiVersion in debugging. (#1914)

Fix the Subscription's apiVersion in eventing debugging example.yaml file.

According to the api register in `https://github.com/knative/eventing/tree/master/pkg/apis/messaging`. 
The Subscription Kind should be in messaging.knative.dev/v1alpha1, while the original file is "eventing.knative.dev/v1alpha1".
If apply the original file, the error happened "error: unable to recognize "example.yaml": no matches for kind "Subscription" in version "eventing.knative.dev/v1alpha1""

This update fix this bug.

* minor typo fix (#1932)

* fix small typo in sample READMEs (#1967)

* fix more broken links

* fix broken links

* update old readfile syntax

* revert dynamic var

* link to folder not readfile source

* fix bad markdown

* fix broken titles and links
2019-12-13 15:29:54 -08:00
RichieEscarez d46de88555 dynamically populate the correct repo branch (#1945) 2019-10-30 17:50:12 -07:00
RichieEscarez 43bfc95a4e update eventing-contrib api (#1941) 2019-10-30 12:14:12 -07:00