Snag list of kpt documentation

[liamfallon]

Just a few small things that should be cleaned up on the kpt documentation

Main page:

• The "edit this page" link on the top right hand side of the page does not work, do we need this link?
• The "FAQ" link on the main page does not work (on the left under the logo)
• The "references" link does not work
• The "catalog of selected krm functions" link just opens the main page again, not the catalog page

Installation page (https://kpt.dev/installation/)

• Double spacing either side of the word "kpt" on the line "Please follow the links below to install kpt components"
• Remove "Package Orchestrator" from the list
• Remove "Config Sync" from list
• Remove "Configuration as Data UI" from the list
• Remove the "Installation of kpt" page altogether as there is only one valid item on the list now.

CLI installation page: https://kpt.dev/installation/kpt-cli/

• Remove the 'kpt-gcloud' section
  kpt fn doc page https://kpt.dev/reference/cli/fn/doc/
• Fix distorted text on page

kpt fn eval page https://kpt.dev/reference/cli/fn/eval/

• Fix distorted text on page
• Fix broken link to "Imperative Function Execution" on the page

kpt fn export page https://kpt.dev/reference/cli/fn/export/

• Fix distorted text on page
• Fix broken link to "Export a Workflow" at the bottom of the page

kpt fn render page https://kpt.dev/reference/cli/fn/render/

• Fix distorted text on page
• Fix broken link to "Declarative Function Execution" on the page

kpt fn sink page https://kpt.dev/reference/cli/fn/sink/

• Fix distorted text on page

kpt fn source page https://kpt.dev/reference/cli/fn/source/

• Fix distorted text on page

Getting Started https://kpt.dev/book/01-getting-started/

• Remove '$' character from the start of command examples to make copy/paste easier
• Replace version v0.9 with v1.0.0-beta.59 of kpt pkg get https://github.com/kptdev/kpt/package-examples/nginx@v0.9 because v0.9 uses kubeval instead of kubeconform.
• Replace update to @v0.10 to upt to @latest

The kpt book: https://kpt.dev/book/

• Remove link to Chapter 8 on Package Orchestration

Chapter 2: Concepts https://kpt.dev/book/02-concepts/

• The text formatting in the "What is kpt? section seems to be off, the first line is indented and is far below the header
  Getting Started https://kpt.dev/book/01-getting-started/
• Remove '$' character from the start of command examples to make copy/paste easier
• Replace version v0.9 with v1.0.0-beta.59 of kpt pkg get https://github.com/kptdev/kpt/package-examples/nginx@v0.9 because v0.9 uses kubeval instead of kubeconform.
• Replace update to @v0.10 to upt to @latest

Chapter 2: Concepts https://kpt.dev/book/02-concepts/

• The text formatting in the "What is kpt? section seems to be off, the first line is indented and is far below the header
• Add a link to the kptdev/krm-functions-sdk on the second "Function SDKs" bullet on the page
• Rephrase the "Function SDKs" bullet text to remove the plural (hangover from typescript being removed?)
• "Function Catalog" link just loads main doc page
• "Package Orchestrator" bullet should be removed
• "config-sync" should be removed
• "backstage UI plugin" probably should be removed
• Change version of wordpress package from "v0.9" to "v1.0.0-beta.59"
• At the end of the Pckages section, the link to the cockrachdb vanilla KRM directory is gone, use spark instead; change the line "For example, cockroachdb is just a vanilla directory of KRM:" to "For example, spark is just a vanilla directory of KRM:"
• Change the link in the kpt pkg get command to https://github.com/kubernetes/examples/tree/master/_archived/spark
• Functions section: Change "A kpt function (also called a KRM function)" to "A KRM function (formerly called a kpt function)"
• Functions section: Change other references in this section from "kpt function" to "KRM function"
• Functions section: Remove reference to the typescript sdk on the first bullet of the second list
• Functions section: Make "Chapter 5" a link to chapter 5 in the line just above the first diagram

Chapter 3: Packages

• Change "Getting a Package" command to kpt pkg get https://github.com/kptdev/kpt.git/package-examples/wordpress@v1.0.0-beta.59
• Change kpt pkg get https://github.com/kptdev/kpt.git/package-examples/wordpress@v0.9 mywordpress to kpt pkg get https://github.com/kptdev/kpt.git/package-examples/wordpress@v1.0.0-beta.59 mywordpress
• Change kpt pkg update wordpress@v0.10 to kpt pkg update wordpress@main
• Change the Kptfile comment from '# Change this from v0.9 to v0.10to# Change this from v1.0.0-beta.59 to main`
• Change the version v0.10 to main after the kpt pkg update wordpress example
• Change git add .; git commit -m "Updated wordpress to v0.10" to git add .; git commit -m "Updated wordpress to main"

Chapter 4: Using Functions

• The "Functions Catalog" link in the Declarative function execution section opens the main doc page on a new tab, not the functions catalog page.
• Fix the badly formatted text in the example line starting with "--mounttype" in the Mounting Directories section
• Check result formatting to a KRM resource once kubeconform bug is fixed in Function Results section

Chapter 5: Developing Functions

• Change page title from "Developing-functions" to "Developing Functions"
• Change "To simplify development, we provide frameworks for developing functions in Go and Typescript." to "To simplify development, we provide a framework for developing functions in Go."
• Change "We recommend limiting their use to" to "We recommend limiting their use if"
• Change "Small amount of logic (< 20 lines)" to "There is a small amount of logic (< 20 lines)
• Change "This standard was published as" to "This standard was published as the"
• Change link text "the kpt funciton SDK" to "the KRM function SDK" in the Developing in go section
• Remove the single item bullet list and the text "General-purpose language:" in the Developing in go section
• Change the link on the "install kpt" hyperlink to point at "https://kpt.dev/installation/kpt-cli/"
• Change the text for the golang version from "at least version 1.19" to "at least version 1.24"
• Update the "initialize your Project" in a specific PR

Chatper 8: Package Orchestration: https://kpt.dev/book/08-package-orchestration/

• Move to the Nephio Porch documentation, see this Nephio issue

CLI Reference https://kpt.dev/reference/cli/

• Fix blank lines under "Overview of kpt commands" and also "$$kpt [PKG_PATH] [flags]$$"
• Fix distorted text on kpt fn doc
• Fix "?>" text on kpt alpha live plan

Guides

• Rationale, pull the Configuraiton as Data document in as a fully fledged document in the documentation.

[liamfallon]

I'm just going through the docs to get ready for Kubecom. Thanks @efiacor for taking this, I'll keep going proof reading.

[liamfallon]

This work is completed