This repository contains the content for the documentation for Tanzu Kubernetes Grid Integrated Edition (TKGI).
In versions 1.7 and earlier, the product was named Enterprise PKS, not TKGI, and those versions of the document set continue to use the name Enterprise PKS.
The content in this repository publishes to the documentation sites at https://docs.pivotal.io/tkgi/index.html and https://docs.pivotal.io/pks/index.html.
Please help us improve the accuracy and completeness of the TKGI documentation by contributing.
One way to to contribute is to file a pull request through GitHub.
Every topic in the documentation has a corresponding file in this repository. Locate the correct file and make a pull request against it. You can also navigate to a topic in the TKGI or Enterprise PKS documentation site and click "View the source for this page in GitHub" at the bottom of the topic to locate the source file of the topic.
| Branch Name | Content | Location |
|---|---|---|
1.15 |
TKGI 1.15 pre-release content | n/a |
1.14 |
TKGI 1.14 released content | https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid-Integrated-Edition/1.14/tkgi/GUID-release-notes.html |
1.13 |
TKGI 1.13 released content | https://docs.pivotal.io/tkgi/1-13/index.html |
1.12 |
TKGI 1.12 released content | https://docs.pivotal.io/tkgi/1-12/index.html |
1.11 |
Reached End of General Support | https://docs.pivotal.io/tkgi/1-11/index.html |
1.10 |
Reached End of General Support | https://docs.pivotal.io/tkgi/1-10/index.html |
1.9 |
Reached End of General Support | https://docs.pivotal.io/tkgi/1-9/index.html |
1.8 |
Reached End of General Support | https://docs.pivotal.io/tkgi/1-8/index.html |
1.7 |
Reached End of General Support | https://docs.pivotal.io/pks/1-7/index.html |
1.6 |
Reached End of General Support | https://docs.pivotal.io/pks/1-6/index.html |
1.5 |
Reached End of General Support | https://docs.pivotal.io/pks/1-5/index.html |
1.4 |
Reached End of General Support | https://docs.pivotal.io/pks/1-4/index.html |
1.3 |
Reached End of General Support | https://docs.pivotal.io/pks/1-3/index.html |
1.2 |
Not in use | N/A (PDF available) |
1.1 |
Not in use | N/A (PDF available) |
1.0-publish |
Not in use | N/A (PDF available) |
0.8 |
Not in use | N/A |
pks-patches |
Staging site for not-yet-released TKGI and Enterprise PKS patches. | Publishes to an internal staging site only. |
1.15: The 1.15 branch is used to publish the pre-release v1.15 version of the site. Create pull requests on 1.15 to contribute bug fixes or correct technical inaccuracies in the v1.15 documentation.
1.12: The 1.14 branch is used to publish the live v1.14 version of the site. Create pull requests on 1.14 to contribute bug fixes or correct technical inaccuracies in the v1.14 documentation.
1.13: The 1.13 branch is used to publish the live v1.13 version of the site. Create pull requests on 1.13 to contribute bug fixes or correct technical inaccuracies in the v1.13 documentation.
1.12: The 1.12 branch is used to publish the live v1.12 version of the site. Create pull requests on 1.12 to contribute bug fixes or correct technical inaccuracies in the v1.12 documentation.
1.11: The 1.11 branch is used to publish the live v1.11 version of the site. Create pull requests on 1.11 to contribute bug fixes or correct technical inaccuracies in the v1.11 documentation.
1.10: The 1.10 branch is used to publish the live v1.10 version of the site. Create pull requests on 1.10 to contribute bug fixes or correct technical inaccuracies in the v1.10 documentation.
1.8: The 1.9 branch is used to publish the live v1.9 version of the site. Create pull requests on 1.9 to contribute bug fixes or correct technical inaccuracies in the v1.9 documentation.
1.8: The 1.8 branch is used to publish the live v1.8 version of the site. Create pull requests on 1.8 to contribute bug fixes or correct technical inaccuracies in the v1.8 documentation.
1.7: The 1.7 branch is used to publish the live v1.7 version of the site. Create pull requests on 1.7 to contribute bug fixes or correct technical inaccuracies in the v1.7 documentation.
1.6: The 1.6 branch is used to publish the live v1.6 version of the site. Create pull requests on 1.6 to contribute bug fixes or correct technical inaccuracies in the v1.6 documentation.
1.6.x-patch-releases: The 1.6.x-patch-releases branch is used to publish the 1.6 site including information for unreleased patches. Create pull requests on 1.6.x-patch-releases to contribute to documentation for unreleased 1.6 patches.
1.5: The 1.5 branch is used to publish the live v1.5 version of the site. Create pull requests on 1.5 to contribute bug fixes or correct technical inaccuracies in the v1.5 documentation.
1.5.x-patch-releases: The 1.5.x-patch-releases branch is used to publish the 1.5 site including information for unreleased patches. Create pull requests on 1.5.x-patch-releases to contribute to documentation for unreleased 1.5 patches.
1.4: The 1.4 branch is used to publish the live v1.4 version of the site. Create pull requests on 1.4 to contribute bug fixes or correct technical inaccuracies in the v1.4 documentation.
1.4.x-patch-releases: The 1.4.x-patch-releases branch is used to publish the 1.4 site including information for unreleased patches. Create pull requests on 1.4.x-patch-releases to contribute to documentation for unreleased 1.4 patches.
1.3: The 1.3 branch is used to publish the live v1.3 version of the site. Create pull requests on 1.3 to contribute bug fixes or correct technical inaccuracies in the v1.3 documentation.
1.3.x-patch-releases: The 1.3.x-patch-releases branch is used to publish the 1.3 site including information for unreleased patches. Create pull requests on 1.3.x-patch-releases to contribute to documentation for unreleased 1.3 patches.
The 1.2 branch is no longer maintained. A PDF of the Enterprise PKS v1.2 documentation is available at https://resources.docs.pivotal.io/pdfs/pks-docs-1.2.pdf.
The 1.1 branch is no longer maintained. A PDF of the Enterprise PKS v1.1 documentation is available at https://resources.docs.pivotal.io/pdfs/pks-docs-1.1.pdf.
The 1.0-publish and 0.8 branches are no longer maintained. A PDF of the Enterprise PKS v1.0 documentation is available at https://resources.docs.pivotal.io/pdfs/pks-docs-1.0.pdf.
Bookbinder is a command-line utility for stitching Markdown documents into a hostable web app. The documentation team uses Bookbinder to publish our documentation sites, but you can also use Bookbinder to view a live version of your documentation on your local machine.
Bookbinder draws the content for the site from this repository, the left navigation menu ("subnav")
from docs-book-pks, and various layout
configuration and assets from docs-layout-repo.
To use Bookbinder to view your documentation, perform the following steps:
- Clone this repository to the
~/workspacedirectory on your local machine. - Clone
docs-book-pksanddocs-layout-repoto the~/workspacedirectory on your local machine. - Navigate into the
docs-book-pksdirectory. - Run
bundle installto install all of the necessary gems, including Bookbinder. - Run
bundle exec bookbinder bind localto build a Rack web-app of the book. After the bind has completed, navigate into thefinal_appdirectory and runrackup. Then navigate tolocalhost:9292/tkgi/1-10/index.htmlin a browser.