Skip to content

Commit

Permalink
Merging public repo to private (#407)
Browse files Browse the repository at this point in the history
* Combining two steps in the super admin and bootstrap section

* Bump acorn from 5.7.3 to 5.7.4

Bumps [acorn](https://github.com/acornjs/acorn) from 5.7.3 to 5.7.4.
- [Release notes](https://github.com/acornjs/acorn/releases)
- [Commits](acornjs/acorn@5.7.3...5.7.4)

Signed-off-by: dependabot[bot] <support@github.com>

* Replacing link placeholders with actual links

* missing slash

* Update dependency rouge to v3.17.0

* updating broken image

* Corrected the header for debugging route (#1856)

X-Kong-Debug is incorrect it doesn't work for returning the routeid in response header, correct name for header is Kong-Debug

* Update dependency gulp-clean-css to v4.3.0

* Update dependency standard to v14.3.3

* docs(audit) describe audit_log_record_ttl behavior (#1864)

* docs(audit) describe audit_log_record_ttl behavior

* Small edits to audit-log page (#1865)

Made some small edits to audit log page.

Co-authored-by: Gayle Neumann <55467607+GayleNeumann@users.noreply.github.com>

* Signal Science Plugin Update (#1866)

* Signal Science Plugin Update

updated version compatibility

* Update app/_hub/signal_sciences/signal-sciences/index.md

Co-Authored-By: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Edited Plugin third-party contributor banner (#1867)

* Edited Plugin third-party contributor banner

Edited Plugin third-party contributor banner to: This plugin is developed, maintained and tested by a third-party contributor, not by Kong Inc."

* Updated banner so won't wrap

* Update app/_layouts/extension.html

Co-Authored-By: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* fix(license) fix instructions for license (#1862)

* Fix image that wasn't working (#1852)

There was one image that was broken for some reason (seems like indentation was incorrect)

* fix(2.0.0) admin api headers (#1851)

* style(base/docs) tweak the heading sizes in docs

This change increases the size difference of some of our docs headers.
h1 gets slightly bigger, h6 gets significantly smaller. The rest of the headings are evenly distributed on the now wider gap.

* style(docs) add a new .indent style for increasing indentation in docs

* docs(2.0.0) regenerate admin API docs

This regenerates the Admin API docs using the changes included in
Kong/kong#5662, which involve:

* Replacing some "fake bold letters headers" with real headers
* Adding the `indent` class to some of the generated headers and tables
* Splitting long field names and default values with word breaks
  so that they don't break table layouts

* Update app/2.0.x/admin-api.md

Co-Authored-By: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

Co-authored-by: Gayle Neumann <55467607+GayleNeumann@users.noreply.github.com>
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* docs(2.0.x/ce) add missing endpoints in Admin API docs

* Describe global variables

Instruct users on how to change the global variables

Fix broken link

Fix grammar

Address comments

More comments

* Describe global variables

* Split immunity docs into separate files

Split Brain/Immunity docs into separate pages

Add new files to nav bar

Fix links

Fix links, add troubleshooting

* updated to latest support matrix and description (#1813)

* updated to latest support matrix and description

updated to latest support matrix and description

* Update app/_hub/cleafy/cleafy/index.md

Co-Authored-By: Aron Eidelman <aron@konghq.com>

* Update app/_hub/cleafy/cleafy/index.md

Co-Authored-By: Aron Eidelman <aron@konghq.com>

* Update app/_hub/cleafy/cleafy/index.md

Co-Authored-By: Aron Eidelman <aron@konghq.com>

* Update app/_hub/cleafy/cleafy/index.md

Co-Authored-By: Aron Eidelman <aron@konghq.com>

* Update app/_hub/cleafy/cleafy/index.md

Co-Authored-By: Aron Eidelman <aron@konghq.com>

* Update app/_hub/cleafy/cleafy/index.md

Co-Authored-By: Aron Eidelman <aron@konghq.com>

* Update app/_hub/cleafy/cleafy/index.md

Co-Authored-By: Aron Eidelman <aron@konghq.com>

* Update app/_hub/cleafy/cleafy/index.md

Co-Authored-By: Aron Eidelman <aron@konghq.com>

* Update app/_hub/cleafy/cleafy/index.md

Co-Authored-By: Aron Eidelman <aron@konghq.com>

* Update app/_hub/cleafy/cleafy/index.md

Co-Authored-By: Aron Eidelman <aron@konghq.com>

* Update app/_hub/cleafy/cleafy/index.md

Co-Authored-By: Aron Eidelman <aron@konghq.com>

* Update app/_hub/cleafy/cleafy/index.md

Co-Authored-By: Aron Eidelman <aron@konghq.com>

* Apply suggestions from code review

Co-Authored-By: Aron Eidelman <aron@konghq.com>

* Update app/_hub/cleafy/cleafy/index.md

Co-Authored-By: Aron Eidelman <aron@konghq.com>

* Updated route_id to true

* Updated compatible versions

* Update app/_hub/cleafy/cleafy/index.md

Co-Authored-By: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* fixing header spacing

Co-authored-by: Andrea Sessa <andrea.sessa@mail.polimi.it>
Co-authored-by: Aron Eidelman <aron@konghq.com>
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Update index.md

* fix(canary) fix omissions in Canary plugin docs (#1868)

* Fixing typos and formatting

* docs(plugins) Changing color of plugin version checkmark (#1878)

* Changing color of plugin version checkmark

* editing the right file

* removing extra semicolon

* docs (plugins) Fixing table styling in plugins (#1877)

* Fixing table styling in plugins

* adding css for table and formatting default values

* A few minor changes (#1875)

* clarify helm 2 vs helm 3 install commands (#1871)

* fix(admin) bind the kong admin api port to 127 (#1869)

* Move db_export note in kong config doc (#1885)

Moved the "db_export" note from after the table to before the table for the kong config param. Needed to make more visible.

* fix(api) update healthcheck endpoint (#1886)

A link was not rendered (so removed)

* docs(portal-cli): update to match readme (#1879)

* docs(portal-cli): update to match readme

* Update cli.md

* docs(portal-cli): fix links

* docs(portal-cli): copy-edit

* fix(health) add upstream health to the reference doc (#1887)

* fix(health) add upstream health to the reference doc

Co-Authored-By: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* docs(cors) `origins` and `exposed_headers` takes an array and the default value was (#1882)

* doc(*) - Update KONG_ADMIN_LISTEN in example (#1881)

Make the admin api listen a value that must be set instead of opening the API to the world by default.

* Add(Brain/Immunity) Add link to public repo for helm chart (#1884)

* Add(Brain/Immunity) Add link to public repo for helm chart for brain/Immunity installation on Kubernetes.

verbage

* Added Set up Collector App using Helm

Added section for Setting up Collector App using Helm and made some minor editing changes.

Co-authored-by: Gayle Neumann <55467607+GayleNeumann@users.noreply.github.com>

* Update DNS caveats (#1835)

* Update DNS caveats

Updated to include that Kong will make a second TCP request if the standard truncated flag is returned by the name server indicating there are further entries to retrieve, these will then be gotten over TCP/DNS
Added clarification that Consul may be ran with truncate flag enabled.

* typo

* Grammar and formatting fixes

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* add changelog for kong-enterprise-k8s 2.0.2.0 release (#1891)

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Add warning about nil args for Exit Transformer (#1897)

* doc(exit-transformer) add warning about nil args

Add a warning about possible nil arguments to exit-transformer
functions, along with an example of how to handle them safely.

* doc(exit-transformer) improve grammar

Co-Authored-By: Gayle Neumann <55467607+GayleNeumann@users.noreply.github.com>

Co-authored-by: Gayle Neumann <55467607+GayleNeumann@users.noreply.github.com>

* docs(hub) Response transformer advanced rename option. (#1896)

* updated oidc.md (#1900)

missing closing quotes on the ODIC config
 "login_redirect_uri": ["https://example.portal.com"],

* docs(admin-api) Content types support multipart. (#1889)

* docs(admin-api) Content types support multipart.

Added multipart as supported content type, and moved
JSON format to beginning of section.

* Update app/2.0.x/admin-api.md

Co-Authored-By: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Update app/2.0.x/admin-api.md

Co-Authored-By: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Fixing typos in plugin layout (#1901)

* chore(*) update release metadata for 2.0.3 (#1905)

* Brain/Immunity: Changed to "Restart Kong" (#1899)

Brain/Immunity: Changed to "Restart Kong". Removed "...to see changes take effect/affect".

* fix(navigation) typo in the url link breaks navigation (#1903)

* fix(ldap) indent code to to render pipe-character properly (#1902)

The pipecharacter | get interpretated as a table separator when
rendered. By indenting we can prevent this.

* Tidy up the plugins executions order (#1907)

* fixing links and code formatting (#1908)

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Renovate Bot <bot@renovateapp.com>
Co-authored-by: satwant singh <satwant.singh@konghq.com>
Co-authored-by: Robert <robert@cryptobells.com>
Co-authored-by: Gayle Neumann <55467607+GayleNeumann@users.noreply.github.com>
Co-authored-by: Thijs Schreijer <thijs@thijsschreijer.nl>
Co-authored-by: Marco A Marquez <marcoam@users.noreply.github.com>
Co-authored-by: Enrique García Cota <kikito@gmail.com>
Co-authored-by: Hisham Muhammad <hisham@gobolinux.org>
Co-authored-by: Amy Wang <awang1596@gmail.com>
Co-authored-by: gnardiello65 <61462937+gnardiello65@users.noreply.github.com>
Co-authored-by: Andrea Sessa <andrea.sessa@mail.polimi.it>
Co-authored-by: Aron Eidelman <aron@konghq.com>
Co-authored-by: Vedant pople <vedantpople4@gmail.com>
Co-authored-by: Gopikrishnan K <43175555+SuperGops7@users.noreply.github.com>
Co-authored-by: Harry <harrybagdi@gmail.com>
Co-authored-by: Colin Hutchinson <hutchic@users.noreply.github.com>
Co-authored-by: Henri Pietila <HenriPro@users.noreply.github.com>
Co-authored-by: zhangzheng <zzgigi2003@163.com>
Co-authored-by: Rob Serafini <42984308+RobSerafini@users.noreply.github.com>
Co-authored-by: creslin <34645187+creslinux@users.noreply.github.com>
Co-authored-by: Travis Raines <traines@konghq.com>
Co-authored-by: baokong <51422077+baokong@users.noreply.github.com>
Co-authored-by: Takafumi Ikeda <takafumi.ikeda@konghq.com>
  • Loading branch information
1 parent 65e196e commit 188f907
Show file tree
Hide file tree
Showing 58 changed files with 2,302 additions and 1,475 deletions.
2 changes: 1 addition & 1 deletion Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ source 'https://rubygems.org'
gem 'jekyll', '3.8.6'
gem 'jekyll-redirect-from'
gem 'redcarpet', '3.5.0'
gem 'rouge', '3.16.0'
gem 'rouge', '3.17.0'
4 changes: 2 additions & 2 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ GEM
rb-inotify (0.10.0)
ffi (~> 1.0)
redcarpet (3.5.0)
rouge (3.16.0)
rouge (3.17.0)
safe_yaml (1.0.5)
sass (3.7.4)
sass-listen (~> 4.0.0)
Expand All @@ -61,7 +61,7 @@ DEPENDENCIES
jekyll (= 3.8.6)
jekyll-redirect-from
redcarpet (= 3.5.0)
rouge (= 3.16.0)
rouge (= 3.17.0)

BUNDLED WITH
1.17.3
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,23 +59,23 @@ scraper to test out config changes.

## Generating the Plugin Development Kit documentation

- Have a local clone of Kong
- Install Luarocks (comes with Kong)
- Have a local clone of Kong.
- Install Luarocks (comes with Kong).
- Install `ldoc` using Luarocks: `luarocks install ldoc 1.4.6`
- In the Kong repository, check out the desired branch/tag/release
- In the Kong repository, check out the desired branch/tag/release.
- Run: `KONG_PATH=path/to/your/kong/folder KONG_VERSION=0.14.x gulp pdk-docs`
- This command will attempt to:
* Obtain an updated list of modules from your local PDK and put it inside
your nav file
your nav file.
* Generate documentation for all the modules in your PDK (where possible) and
put in a folder inside your version docs
put in a folder inside your version docs.

## Generating the Admin API, CLI and Configuration Documentation

- Make sure that the `resty` and `luajit` executables are in your `$PATH` (installing kong should install them)
- Several Lua rocks are needed. The easiest way to get all of them is to execute `make dev` in the Kong folder
- Have a local clone of Kong
- In the Kong repository, check out the desired branch/tag/release
- Make sure that the `resty` and `luajit` executables are in your `$PATH` (installing kong should install them).
- Several Lua rocks are needed. The easiest way to get them all is to execute `make dev` in the Kong folder
- Have a local clone of Kong.
- In the Kong repository, check out the desired branch/tag/release.
- To generate the Admin API docs:
- Run: `KONG_PATH=path/to/your/kong/folder KONG_VERSION=0.14.x gulp admin-api-docs`
- This command will attempt to:
Expand Down
16 changes: 10 additions & 6 deletions app/1.4.x/kong-for-kubernetes/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,18 @@ Adjust “knobs” based on your use case:
Kong has an official Helm Chart. To deploy Kong onto your Kubernetes cluster with Helm, use:

```
helm repo add kong https://charts.konghq.com
helm repo update
helm install kong/kong
```
$ helm repo add kong https://charts.konghq.com
$ helm repo update
# Helm 2
$ helm install kong/kong
For more information about using a Helm Chart, see Kong's
[Charts repo](https://github.com/Kong/charts/blob/master/charts/kong/README.md).
# Helm 3
$ helm install kong/kong --generate-name --set ingressController.installCRDs=false
```

For more information about using a Helm Chart, see chart
[documentation](https://github.com/Kong/charts/blob/master/charts/kong/README.md).

### Kustomize
Kong’s manifests for Kubernetes can be declaratively patched using Kubernetes’ [kustomize](https://kustomize.io/). An example of a remote custom build is:
Expand Down
16 changes: 10 additions & 6 deletions app/1.5.x/kong-for-kubernetes/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,18 @@ Adjust “knobs” based on your use case:
Kong has an official Helm Chart. To deploy Kong onto your Kubernetes cluster with Helm, use:

```
helm repo add kong https://charts.konghq.com
helm repo update
helm install kong/kong
```
$ helm repo add kong https://charts.konghq.com
$ helm repo update
# Helm 2
$ helm install kong/kong
For more information about using a Helm Chart, see Kong's
[Charts repo](https://github.com/Kong/charts/blob/master/charts/kong/README.md).
# Helm 3
$ helm install kong/kong --generate-name --set ingressController.installCRDs=false
```

For more information about using a Helm Chart, see chart
[documentation](https://github.com/Kong/charts/blob/master/charts/kong/README.md).

### Kustomize
Kong’s manifests for Kubernetes can be declaratively patched using Kubernetes’ [kustomize](https://kustomize.io/). An example of a remote custom build is:
Expand Down
704 changes: 459 additions & 245 deletions app/2.0.x/admin-api.md

Large diffs are not rendered by default.

Loading

0 comments on commit 188f907

Please sign in to comment.