### Install Dependencies and Run Docs Dev Server

Source: https://github.com/kyma-project/kyma/blob/main/hack/README.md

Installs project dependencies and starts the documentation development server. Ensure you are in the 'hack' directory before running.

```bash
npm install
npm run docs:dev
```

--------------------------------

### Install Serverless Module

Source: https://github.com/kyma-project/kyma/blob/main/docs/02-get-started/01-quick-install.md

Installs the Serverless operator and its default CR in the 'kyma-system' namespace.

```bash
kubectl apply -f https://github.com/kyma-project/serverless-manager/releases/latest/download/serverless-operator.yaml
kubectl apply -f https://github.com/kyma-project/serverless-manager/releases/latest/download/default-serverless-cr.yaml  -n kyma-system
```

--------------------------------

### Install Keda Module

Source: https://github.com/kyma-project/kyma/blob/main/docs/02-get-started/01-quick-install.md

Deploys the Keda manager and its default CR to the 'kyma-system' namespace.

```bash
kubectl apply -f https://github.com/kyma-project/keda-manager/releases/latest/download/keda-manager.yaml
kubectl apply -f https://github.com/kyma-project/keda-manager/releases/latest/download/keda-default-cr.yaml -n kyma-system
```

--------------------------------

### Install Istio Module

Source: https://github.com/kyma-project/kyma/blob/main/docs/02-get-started/01-quick-install.md

Installs the Istio module by applying the manager and default CR. Requires the 'kyma-system' namespace to be labeled for Istio injection.

```bash
kubectl label namespace kyma-system istio-injection=enabled --overwrite
kubectl apply -f https://github.com/kyma-project/istio/releases/latest/download/istio-manager.yaml
kubectl apply -f https://github.com/kyma-project/istio/releases/latest/download/istio-default-cr.yaml
```

--------------------------------

### Build and Preview Docs Server

Source: https://github.com/kyma-project/kyma/blob/main/hack/README.md

Builds the documentation for production and then starts a preview server. The build process copies unreferenced assets to the 'docs/public' directory.

```bash
npm run docs:build
npm run docs:preview
```

--------------------------------

### Install NATS Module

Source: https://github.com/kyma-project/kyma/blob/main/docs/02-get-started/01-quick-install.md

Deploys the NATS manager and its default CR to the 'kyma-system' namespace.

```bash
kubectl apply -f https://github.com/kyma-project/nats-manager/releases/latest/download/nats-manager.yaml
kubectl apply -f https://github.com/kyma-project/nats-manager/releases/latest/download/nats-default-cr.yaml -n kyma-system
```

--------------------------------

### Install Application Connector Module

Source: https://github.com/kyma-project/kyma/blob/main/docs/02-get-started/01-quick-install.md

Applies the Application Connector manager and its default CR to the 'kyma-system' namespace.

```bash
kubectl apply -f https://github.com/kyma-project/application-connector-manager/releases/latest/download/application-connector-manager.yaml
kubectl apply -f https://github.com/kyma-project/application-connector-manager/releases/latest/download/default_application_connector_cr.yaml -n kyma-system
```

--------------------------------

### Install Eventing Module

Source: https://github.com/kyma-project/kyma/blob/main/docs/02-get-started/01-quick-install.md

Installs the Eventing manager and its default CR. For NATS backend, ensure NATS module is installed first and configure the backend using the provided patch command.

```bash
kubectl apply -f https://github.com/kyma-project/eventing-manager/releases/latest/download/eventing-manager.yaml
kubectl apply -f https://github.com/kyma-project/eventing-manager/releases/latest/download/eventing-default-cr.yaml -n kyma-system
```

```bash
kubectl patch eventings.operator.kyma-project.io eventing -n kyma-system --type=merge -p '{"spec":{"backend":{"type":"NATS"}}}'
```

--------------------------------

### Install Telemetry Module

Source: https://github.com/kyma-project/kyma/blob/main/docs/02-get-started/01-quick-install.md

Applies the Telemetry manager and its default CR to the 'kyma-system' namespace.

```bash
kubectl apply -f https://github.com/kyma-project/telemetry-manager/releases/latest/download/telemetry-manager.yaml
kubectl apply -f https://github.com/kyma-project/telemetry-manager/releases/latest/download/telemetry-default-cr.yaml -n kyma-system
```

--------------------------------

### Install API Gateway Module

Source: https://github.com/kyma-project/kyma/blob/main/docs/02-get-started/01-quick-install.md

Applies the API Gateway manager and its default CR. Requires the 'kyma-system' namespace to be labeled for Istio injection.

```bash
kubectl label namespace kyma-system istio-injection=enabled --overwrite
kubectl apply -f https://github.com/kyma-project/api-gateway/releases/latest/download/api-gateway-manager.yaml
kubectl apply -f https://github.com/kyma-project/api-gateway/releases/latest/download/apigateway-default-cr.yaml
```

--------------------------------

### VitePress Sidebar Configuration

Source: https://github.com/kyma-project/kyma/blob/main/docs/vitepress-structure.md

Example of a sidebar configuration file for a specific module. Paths are relative and will be transformed to absolute paths by `makeSidebarAbsolutePath`.

```typescript
const sidebar = [
  {
    text: 'Module Overview',
    link: '/docs/module-a/overview'
  },
  {
    text: 'API Reference',
    children: [
      { text: 'Endpoints', link: '/docs/module-a/api/endpoints' },
      { text: 'Data Models', link: '/docs/module-a/api/models' }
    ]
  }
]

export default sidebar
```

--------------------------------

### Install SAP BTP Operator Module

Source: https://github.com/kyma-project/kyma/blob/main/docs/02-get-started/01-quick-install.md

Deploys the SAP BTP Operator and its default CR. Note the warning about a missing secret, refer to the provided link for its creation.

```bash
kubectl apply -f https://github.com/kyma-project/btp-manager/releases/latest/download/btp-manager.yaml
kubectl apply -f https://github.com/kyma-project/btp-manager/releases/latest/download/btp-operator-default-cr.yaml -n kyma-system
```

--------------------------------

### Create k3d Cluster for Kyma

Source: https://github.com/kyma-project/kyma/blob/main/docs/02-get-started/01-quick-install.md

Provisions a k3d cluster named 'kyma' with specific port mappings and disables Traefik. Ensure you have k3d installed.

```bash
k3d cluster create kyma --kubeconfig-switch-context -p '30080:80@loadbalancer' -p '30443:443@loadbalancer' --k3s-arg '--disable=traefik@server:*' --k3s-arg '--tls-san=host.docker.internal@server:*'
kubectl create ns kyma-system
```

--------------------------------

### Dynamically Define Rules with buildpack-mount

Source: https://github.com/kyma-project/kyma/blob/main/common/makefiles/docs/generic-make-go.md

This Makefile snippet demonstrates how the `buildpack-mount` function is used to dynamically define rules for targets listed in `MOUNT_TARGETS`. Each target gets a rule generated that mounts the component's directory.

```makefile
MOUNT_TARGETS = build resolve ensure dep-status check-imports imports check-fmt fmt errcheck vet generate gqlgen
$(foreach t,$(MOUNT_TARGETS),$(eval $(call buildpack-mount,$(t))))
```

--------------------------------

### Resolve Dependencies

Source: https://github.com/kyma-project/kyma/blob/main/common/makefiles/docs/generic-make-go.md

Run `resolve` or `resolve-local` to install dependencies defined in `Gopkg.lock` without modifying the lock file. The `-local` suffix indicates execution outside the Docker container.

```makefile
resolve
resolve-local
```

--------------------------------

### Execute Local Rule within Docker Container

Source: https://github.com/kyma-project/kyma/blob/main/common/makefiles/docs/generic-make-go.md

This Makefile example shows a dynamically generated `resolve` rule that executes a `make resolve-local` command inside a Docker container. It highlights the mounting of the component directory for the container.

```makefile
resolve:
    @echo make resolve
    @docker run $(DOCKER_INTERACTIVE) \
        -v $(COMPONENT_DIR):$(WORKSPACE_COMPONENT_DIR):delegated \
        $(DOCKER_CREATE_OPTS) make resolve-local
```

--------------------------------

### Define Table Generation Markers in Markdown

Source: https://github.com/kyma-project/kyma/blob/main/hack/table-gen/README.md

Use these HTML comments to mark the start and end points in your Markdown file where the CRD documentation table should be inserted.

```html
<!-- TABLE-START -->

<!-- TABLE-END -->
```

--------------------------------

### Get Certificate CR Status

Source: https://github.com/kyma-project/kyma/blob/main/docs/04-operation-guides/troubleshooting/security/sec-01-certificates-gardener.md

Use this command to check the status of all Certificate custom resources across all namespaces. This helps identify which certificates are in an 'Error' state.

```bash
kubectl get certificates.cert.gardener.cloud --all-namespaces
```

--------------------------------

### Get Certificate Secret Reference

Source: https://github.com/kyma-project/kyma/blob/main/docs/04-operation-guides/troubleshooting/security/sec-01-certificates-gardener.md

Find the name and namespace of the Kubernetes Secret associated with a Certificate resource. This is necessary for deleting the incorrect certificate and ensuring a clean re-request.

```bash
kubectl get certificates -n {CERTIFICATE_NAMESPACE} {CERTIFICATE_NAME} -o jsonpath='{ .spec.secretRef }'
```

--------------------------------

### Get Certificate Status Message

Source: https://github.com/kyma-project/kyma/blob/main/docs/04-operation-guides/troubleshooting/security/sec-01-certificates-gardener.md

Retrieve the detailed status message for a specific Certificate CR in a given namespace. This message provides the reason for the certificate issuance failure.

```bash
kubectl get certificates -n {CERTIFICATE_NAMESPACE} {CERTIFICATE_NAME} -o jsonpath='{ .status.message }'
```

--------------------------------

### VitePress Tabs Plugin Syntax

Source: https://github.com/kyma-project/kyma/blob/main/docs/vitepress-structure.md

Processes custom tab syntax in markdown files using a VitePress plugin. It parses blocks marked with <!-- tabs:start --> and <!-- tabs:end -->.

```javascript
const TABS_REGEX = /<!-- tabs:start -->\n(.*?)\n<!-- tabs:end -->/gs;
const TAB_TITLE_REGEX = /#### \*\*(.*?)\*\*\n/;

export default {
  name: 'tabs-plugin',
  transform(markdown) {
    const matches = markdown.matchAll(TABS_REGEX);
    // ... processing logic ...
    return markdown.replace(TABS_REGEX, (match, content) => {
      const tabs = content.split('\n---\n').map(tabContent => {
        const titleMatch = tabContent.match(TAB_TITLE_REGEX);
        const title = titleMatch ? titleMatch[1] : 'Tab';
        const text = tabContent.replace(TAB_TITLE_REGEX, '').trim();
        return { title, text: btoa(text) };
      });
      return `<Tabs :tabs-data="${JSON.stringify(tabs)}" />`;
    });
  }
}
```

--------------------------------

### Import VirtualService Domains to Hosts File

Source: https://github.com/kyma-project/kyma/blob/main/docs/04-operation-guides/troubleshooting/01-kyma-domain-unresolvable.md

Run this command to automatically add the necessary VirtualService domains to your local system's hosts file, resolving domain resolution issues.

```bash
sudo kyma import hosts
```

--------------------------------

### Build Go Binary

Source: https://github.com/kyma-project/kyma/blob/main/common/makefiles/docs/generic-make-go.md

Use `build` or `build-local` to compile the Go binary. The `-local` suffix indicates execution outside the Docker container.

```makefile
build
build-local
```

--------------------------------

### Basic Makefile Usage

Source: https://github.com/kyma-project/kyma/blob/main/common/makefiles/docs/generic-make-go.md

The generic Makefile supports various rules for different development tasks. Run `make` without arguments to execute the default `verify` rule.

```bash
make {RULE}
```

--------------------------------

### Run CRD Documentation Generator from Command Line

Source: https://github.com/kyma-project/kyma/blob/main/hack/table-gen/README.md

Execute the table generator directly using `go run` to generate documentation tables. Specify the CRD file and the target Markdown file as arguments.

```bash
go run main.go --crd-filename ../../installation/resources/crds/telemetry/logpipelines.crd.yaml --md-filename ../../docs/05-technical-reference/00-custom-resources/telemetry-01-logpipeline.md
```

--------------------------------

### Run Unit Tests

Source: https://github.com/kyma-project/kyma/blob/main/common/makefiles/docs/generic-make-go.md

Use `test` or `test-local` to run all unit tests for the Go component. The `-local` suffix indicates execution outside the Docker container.

```makefile
test
test-local
```

--------------------------------

### Create Volume Snapshot

Source: https://github.com/kyma-project/kyma/blob/main/docs/04-operation-guides/operations/10-backup-kyma.md

Use this command to create a VolumeSnapshot resource for manual volume backup. Replace {NAMESPACE} and {YOUR_PVC_NAME} with your specific values.

```yaml
kubectl apply -n {NAMESPACE} -f <<EOF
apiVersion: snapshot.storage.k8s.io/v1
kind: VolumeSnapshot
metadata:
  name: snapshot
spec:
  volumeSnapshotClassName: default
  source:
    persistentVolumeClaimName: {YOUR_PVC_NAME}
EOF
```

--------------------------------

### GitHub Actions Workflow for Documentation Deployment

Source: https://github.com/kyma-project/kyma/blob/main/docs/vitepress-structure.md

This GitHub Actions workflow automates daily documentation updates. It can also be triggered manually. It copies content, builds artifacts, and deploys documentation.

```yaml
name: Update documentation

# Controls when the action will run.
# For example, every day at midnight.
on:
  schedule:
    # * is a valid cron syntax so will be ignored
    - cron: "0 0 * * *"
  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# A workflow run is made up of one or more jobs that can be run independently.
jobs:
  # The following is a basic example for a mattermost notification
  # to be sent when a workflow run is triggered.
  #
  # To complete the configuration:
  # 1. Set the corresponding value in the corresponding GitHub secrets
  #    available through the actions console.
  # 2. Add the corresponding environment variable to the corresponding GitHub
  #    repository.
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Setup Node.js
        uses: actions/setup-node@v3
        with:
          node-version: '18'
      - name: Install dependencies
        run: npm ci
      - name: Build and deploy documentation
        env:
          GH_TOKEN: ${{ secrets.GH_TOKEN }}
        run: |
          cp -r docs/user/* external-content/
          cp -r docs/assets/* external-content/
          npm run build
          npm run deploy
```

--------------------------------

### Check Go File Formatting

Source: https://github.com/kyma-project/kyma/blob/main/common/makefiles/docs/generic-make-go.md

Use `check-fmt` or `check-fmt-local` to verify the formatting of Go files without making changes. The `-local` suffix indicates execution outside the Docker container.

```makefile
check-fmt
check-fmt-local
```

--------------------------------

### Format Go Files

Source: https://github.com/kyma-project/kyma/blob/main/common/makefiles/docs/generic-make-go.md

Execute `fmt` or `fmt-local` to automatically format Go files according to project standards. The `-local` suffix indicates execution outside the Docker container.

```makefile
fmt
fmt-local
```

--------------------------------

### Add Generic Makefile to Project

Source: https://github.com/kyma-project/kyma/blob/main/common/makefiles/docs/generic-make-go.md

Include these variables and the include statement in your Makefile to integrate the generic Go build system.

```makefile
APP_NAME = {APPLICATION NAME}
APP_PATH = {APPLICATION PATH IN REPOSITORY}
BUILDPACK = {BUILDPACK IMAGE}
SCRIPTS_DIR = {GENERIC MAKEFILE PATH}
include $(SCRIPTS_DIR)/generic-make-go.mk
```

--------------------------------

### Verify Go Component

Source: https://github.com/kyma-project/kyma/blob/main/common/makefiles/docs/generic-make-go.md

The `verify` rule runs `test`, `check-fmt`, `check-imports`, and `errcheck` sequentially to ensure the Go component meets quality standards. This is the default rule when `make` is run without arguments.

```makefile
verify
```

--------------------------------

### Kyma Documentation Index Page

Source: https://github.com/kyma-project/kyma/blob/main/docs/vitepress-structure.md

Configuration for the Kyma documentation landing page using VitePress home layout. Includes hero section, features grid, and additional content sections.

```javascript
export default {
  layout: 'home',
  // ... other frontmatter properties
  features: [
    { title: 'Feature 1', details: 'Description 1', icon: '/icons/icon1.svg' },
    // ... other features
  ],
  features_additional: {
    title: 'Adopters',
    logos: [
      { src: '/logos/logo1.svg', alt: 'Company 1', width: 100, height: 50 },
      // ... other logos
    ]
  }
}
```

--------------------------------

### Clone Kyma Repository

Source: https://github.com/kyma-project/kyma/blob/main/CONTRIBUTING.md

Use this command to clone the Kyma repository into your `$GOPATH` workspace, creating the necessary folder structure.

```bash
git clone git@github.com:{GitHubUsername}/kyma.git $GOPATH/src/github.com/kyma-project/kyma
```

--------------------------------

### Vet Go Source Code

Source: https://github.com/kyma-project/kyma/blob/main/common/makefiles/docs/generic-make-go.md

Run `vet` or `vet-local` to examine Go source code for suspicious constructs. The `-local` suffix indicates execution outside the Docker container.

```makefile
vet
vet-local
```

--------------------------------

### Format Go Imports

Source: https://github.com/kyma-project/kyma/blob/main/common/makefiles/docs/generic-make-go.md

Run `imports` or `imports-local` to automatically format Go imports. The `-local` suffix indicates execution outside the Docker container.

```makefile
imports
imports-local
```

--------------------------------

### Build CI Docker Image

Source: https://github.com/kyma-project/kyma/blob/main/common/makefiles/docs/generic-make-go.md

The `build-image` rule is used to build the Docker image utilized in the CI environment.

```makefile
build-image
```

--------------------------------

### Check Istio Ingress Gateway Annotations

Source: https://github.com/kyma-project/kyma/blob/main/docs/04-operation-guides/troubleshooting/security/sec-01-certificates-gardener.md

Verify the annotations on the `istio-ingressgateway` Service in the `istio-system` namespace. These annotations are crucial for correct domain name configuration for certificates.

```yaml
dns.gardener.cloud/class=garden
dns.gardener.cloud/dnsnames=*.{DOMAIN}
```

--------------------------------

### Push CI Docker Image

Source: https://github.com/kyma-project/kyma/blob/main/common/makefiles/docs/generic-make-go.md

Use the `push-image` rule to push the built Docker image to the registry used in the CI environment.

```makefile
push-image
```

--------------------------------

### Create k3d Cluster with Custom Ports

Source: https://github.com/kyma-project/kyma/blob/main/docs/04-operation-guides/troubleshooting/01-k3d-fails-on-linux.md

Use this command to create a k3d cluster when default ports 80 and 443 are unavailable on Linux. It maps custom ports (e.g., 8080 and 8443) to the load balancer's ports.

```bash
k3d cluster create -p 8080:80@loadbalancer -p 8443:443@loadbalancer
```

--------------------------------

### Check Go File Imports

Source: https://github.com/kyma-project/kyma/blob/main/common/makefiles/docs/generic-make-go.md

Use `check-imports` or `check-imports-local` to verify that Go file imports are correctly formatted and organized. The `-local` suffix indicates execution outside the Docker container.

```makefile
check-imports
check-imports-local
```

--------------------------------

### Ensure Dependencies

Source: https://github.com/kyma-project/kyma/blob/main/common/makefiles/docs/generic-make-go.md

Use `ensure` or `ensure-local` to download dependencies defined in `Gopkg.lock` and update the lock file. The `-local` suffix indicates execution outside the Docker container.

```makefile
ensure
ensure-local
```

--------------------------------

### Check GraphQL Schema Update

Source: https://github.com/kyma-project/kyma/blob/main/common/makefiles/docs/generic-make-go.md

After running `gqlgen`, use `check-gqlgen` or `check-gqlgen-local` to ensure the GraphQL schema is up-to-date. The `-local` suffix indicates execution outside the Docker container.

```makefile
check-gqlgen
check-gqlgen-local
```

--------------------------------

### Generate GraphQL Schema

Source: https://github.com/kyma-project/kyma/blob/main/common/makefiles/docs/generic-make-go.md

Use `gqlgen` or `gqlgen-local` to generate the GraphQL schema. The `-local` suffix indicates execution outside the Docker container.

```makefile
gqlgen
gqlgen-local
```

--------------------------------

### Package JSON Scripts

Source: https://github.com/kyma-project/kyma/blob/main/docs/vitepress-structure.md

This package.json file contains scripts for development, build, and preview tasks within the project.

```json
{
  "name": "kyma-docs",
  "version": "0.0.0",
  "private": true,
  "scripts": {
    "dev": "vitepress dev",
    "build": "vitepress build",
    "preview": "vitepress preview",
    "deploy": "./scripts/deploy.sh"
  },
  "devDependencies": {
    "vitepress": "1.0.0-alpha.75"
  }
}
```

--------------------------------

### Configure VitePress Search

Source: https://github.com/kyma-project/kyma/blob/main/docs/vitepress-structure.md

Configures the search component for VitePress. Ensure Algolia is set up if using this configuration.

```javascript
function getSearchConfig() {
  return {
    provider: 'algolia',
    options: {
      appId: '...', 
      apiKey: '...', 
      indexName: '...' 
    }
  }
}
```

--------------------------------

### Bash Script for Local External Content Aggregation

Source: https://github.com/kyma-project/kyma/blob/main/docs/vitepress-structure.md

This Bash script automates the aggregation of external documentation content for local development. It clones repositories, copies specific directories, handles errors, and cleans up cloned repositories.

```bash
#!/bin/bash

# Exit immediately if a command exits with a non-zero status.
set -e

# Define the target directory for external content
TARGET_DIR="../docs/external-content"

# Define the repositories to clone and copy content from
REPOS=("kyma-project/control-plane" "kyma-project/developer-portal" "kyma-project/examples" "kyma-project/telemetry-manager")

# Create the target directory if it doesn't exist
mkdir -p "$TARGET_DIR"

# Loop through each repository
for repo in "${REPOS[@]}"; do
  echo "Processing repository: $repo"
  REPO_NAME=$(basename "$repo")
  REPO_DIR="/tmp/$REPO_NAME"

  # Clone the repository
  git clone "https://github.com/$repo.git" "$REPO_DIR"

  # Define source directories within the cloned repository
  SOURCE_USER_DIR="$REPO_DIR/docs/user"
  SOURCE_ASSETS_DIR="$REPO_DIR/docs/assets"

  # Define destination directories
  DEST_USER_DIR="$TARGET_DIR/$REPO_NAME/docs/user"
  DEST_ASSETS_DIR="$TARGET_DIR/$REPO_NAME/docs/assets"

  # Copy user documentation if the directory exists
  if [ -d "$SOURCE_USER_DIR" ]; then
    mkdir -p "$(dirname "$DEST_USER_DIR")"
    cp -r "$SOURCE_USER_DIR" "$TARGET_DIR/$REPO_NAME/docs/"
    echo "Copied $SOURCE_USER_DIR to $DEST_USER_DIR"
  else
    echo "Warning: $SOURCE_USER_DIR not found in $repo"
  fi

  # Copy assets if the directory exists
  if [ -d "$SOURCE_ASSETS_DIR" ]; then
    mkdir -p "$(dirname "$DEST_ASSETS_DIR")"
    cp -r "$SOURCE_ASSETS_DIR" "$TARGET_DIR/$REPO_NAME/docs/"
    echo "Copied $SOURCE_ASSETS_DIR to $DEST_ASSETS_DIR"
  else
    echo "Warning: $SOURCE_ASSETS_DIR not found in $repo"
  fi

  # Clean up the cloned repository
  rm -rf "$REPO_DIR"
  echo "Cleaned up $REPO_DIR"
done

echo "External content aggregation complete."
```

--------------------------------

### Add New Rule to Generic Makefile

Source: https://github.com/kyma-project/kyma/blob/main/common/makefiles/docs/generic-make-go.md

To introduce a new rule into the generic Makefile, define a local rule in `generic_make_go.mk` and subsequently add the rule's name to either the `MOUNT_TARGETS` or `COPY_TARGETS` variables.

```makefile
{YOUR_RULE}-local:  {COMMANDS}
```

--------------------------------

### Run errcheck Program

Source: https://github.com/kyma-project/kyma/blob/main/common/makefiles/docs/generic-make-go.md

Execute `errcheck` or `errcheck-local` to check for unhandled errors in Go code. The `-local` suffix indicates execution outside the Docker container.

```makefile
errcheck
errcheck-local
```

--------------------------------

### Add Local Rule Without Buildpack

Source: https://github.com/kyma-project/kyma/blob/main/common/makefiles/docs/generic-make-go.md

Define a new local rule in your Makefile and integrate it into a global rule using the `::` operator. This method is for rules that do not require buildpack functionality.

```makefile
verify:: {YOUR_RULE}
```

--------------------------------

### Makefile Target for CRD Documentation Generation

Source: https://github.com/kyma-project/kyma/blob/main/hack/table-gen/README.md

This Makefile target automates the generation of CRD documentation tables by calling the `table-gen` binary with specified CRD and Markdown file paths.

```makefile
.PHONY: crd-docs-gen
crd-docs-gen:
	table-gen --crd-filename ./path/to/your-crd.yaml --md-filename ./docs/user/your-doc.md
	table-gen --crd-filename ./path/to/your-crd-2.yaml --md-filename ./docs/user/your-doc-2.md
	...
```

--------------------------------

### Update CoreDNS for Local Domain Resolution

Source: https://github.com/kyma-project/kyma/blob/main/docs/02-get-started/01-quick-install.md

Configures CoreDNS to resolve `.local.kyma.dev` domains to the Istio ingress gateway. This involves creating a ConfigMap and restarting the CoreDNS deployment.

```bash
cat <<EOF | kubectl apply -f -
apiVersion: v1
kind: ConfigMap
metadata:
  name: coredns-custom
  namespace: kube-system
data:
  kyma.override: |
    rewrite name regex (.*)\.local\.kyma\.dev istio-ingressgateway.istio-system.svc.cluster.local
EOF

kubectl rollout restart deployment -n kube-system coredns
```

--------------------------------

### Configure VitePress Theme

Source: https://github.com/kyma-project/kyma/blob/main/docs/vitepress-structure.md

Configures the VitePress theme, including navigation, sidebar, and social links. Sidebar structure is imported from external modules.

```javascript
theme: {
  logo: '/kyma-logo.svg',
  nav: [
    { text: 'Home', link: '/' },
    { text: 'Docs', link: '/docs/' },
    { text: 'Blog', link: '/blog/' }
  ],
  sidebar: {
    '/docs/': [
      { text: 'Introduction', link: '/docs/introduction' },
      { text: 'Getting Started', link: '/docs/getting-started' }
    ]
  },
  socialLinks: [
    { icon: 'github', link: 'https://github.com/kyma-project/kyma' },
    { icon: 'twitter', link: 'https://twitter.com/kyma_project' }
  ]
}
```

--------------------------------

### Define VitePress Site Metadata

Source: https://github.com/kyma-project/kyma/blob/main/docs/vitepress-structure.md

Defines essential site metadata for VitePress, including title, description, and base path. Adjust the base path if Kyma is hosted on a sub-directory.

```javascript
defineConfig({
  lang: 'en-US',
  title: 'Kyma',
  description: 'Kyma Documentation',
  base: '/Kyma/',
  // ... other configurations
})
```

--------------------------------

### Check Dependency Status

Source: https://github.com/kyma-project/kyma/blob/main/common/makefiles/docs/generic-make-go.md

Execute `dep-status` or `dep-status-local` to print the current status of project dependencies. The `-local` suffix indicates execution outside the Docker container.

```makefile
dep-status
dep-status-local
```

--------------------------------

### Bash Script for Public Asset Distribution

Source: https://github.com/kyma-project/kyma/blob/main/docs/vitepress-structure.md

This Bash script manages asset distribution for public use. It scans the `./docs/` directory, excludes development files and specific directories, copies qualifying files to `./docs/public/`, and maintains directory structure.

```bash
#!/bin/bash

# Exit immediately if a command exits with a non-zero status.
set -e

# Define the source and destination directories
SOURCE_DIR="./docs"
DEST_DIR="./docs/public"

# Define exclusion patterns for files and directories
EXCLUDE_PATTERNS=("*.md" "*.ts" "*.js" "*.vue" "*.css" "*.yml" "*.yaml" "*.sh" "*.env" "*.log" "*.DS_Store" ".vitepress" ".git" ".github" "node_modules" "package.json" "README.md")

# Create the destination directory if it doesn't exist
mkdir -p "$DEST_DIR"

# Function to check if a file or directory should be excluded
should_exclude() {
  local item="$1"
  for pattern in "${EXCLUDE_PATTERNS[@]}"; do
    if [[ "$item" == $pattern ]]; then
      return 0 # Exclude
    fi
  done
  return 1 # Do not exclude
}

# Find and copy files, maintaining directory structure
find "$SOURCE_DIR" -type f | while read -r file;
  do
    # Get the relative path from the source directory
    relative_path="${file#$SOURCE_DIR/}"

    # Check if the file or any part of its path should be excluded
    exclude=false
    # Check the file itself
    if should_exclude "$relative_path"; then
      exclude=true
    fi
    # Check parent directories
    IFS='/' read -ra path_parts <<< "$relative_path"
    current_path=""
    for (( i=0; i<${#path_parts[@]}-1; i++ )); do
      current_path="$current_path${path_parts[i]}/"
      if should_exclude "$current_path"; then
        exclude=true
        break
      fi
    done

    if [ "$exclude" = false ]; then
      # Create necessary target directories
      mkdir -p "$DEST_DIR/$(dirname "$relative_path")"
      # Copy the file
      cp "$file" "$DEST_DIR/$relative_path"
      echo "Copied: $relative_path to $DEST_DIR/$relative_path"
    else
      echo "Excluded: $relative_path"
    fi
  done

# Special handling for the entire assets folder
if [ -d "$SOURCE_DIR/assets" ]; then
  echo "Copying entire assets folder to $DEST_DIR/assets"
  cp -r "$SOURCE_DIR/assets" "$DEST_DIR/"
fi

echo "Asset distribution complete."
```

--------------------------------

### Execute Prettier for Code Formatting

Source: https://github.com/kyma-project/kyma/blob/main/hack/README.md

Manually formats code across various file types using Prettier. This command is useful if automatic formatting on commit is not active.

```bash
npx prettier --config ./.prettierrc --ignore-path ./.prettierignore --write '**/*.{ts,tsx,mjs,js,jsx,json,html,css,yaml,md}'
```

--------------------------------

### Add Local Rule Requiring Buildpack

Source: https://github.com/kyma-project/kyma/blob/main/common/makefiles/docs/generic-make-go.md

To add a local rule that utilizes buildpack functionality, define the rule and its associated commands, then use the `eval $(call {BUILDPACK_FUNCTION},{RULE})` pattern to dynamically create the rule.

```makefile
{RULE}-local: {COMMANDS}

# Function which creates the new rule dynamically
$(eval $(call {BUILDPACK_FUNCTION},{RULE}))
```

--------------------------------

### Custom VitePress Layout

Source: https://github.com/kyma-project/kyma/blob/main/docs/vitepress-structure.md

Extends the default VitePress layout to include custom components like MyFooter and FeaturesAdd. Ensures client-side routing compatibility for legacy URLs.

```vue
<template>
  <div id="layout">
    <Layout />
    <MyFooter />
    <FeaturesAdd />
  </div>
</template>

<script setup>
import Layout from 'vitepress/theme/Layout.vue'
import MyFooter from './MyFooter.vue'
import FeaturesAdd from './Features-add.vue'
</script>

<style>
/* Custom layout styles */
</style>
```

--------------------------------

### Delete Kyma Module Custom Resource

Source: https://github.com/kyma-project/kyma/blob/main/docs/02-get-started/08-uninstall-upgrade-kyma-module.md

Use this command to delete a specific Kyma module's custom resource. Ensure you have the correct path to the module's CR.

```bash
kubectl delete {PATH_TO_THE_MODULE_CUSTOM_RESOURCE}
```

--------------------------------

### Register Custom VitePress Components

Source: https://github.com/kyma-project/kyma/blob/main/docs/vitepress-structure.md

Registers custom Vue components globally within VitePress. This allows using components like Tabs throughout the documentation.

```javascript
import DefaultTheme from 'vitepress/theme'
import Layout from './Layout.vue'
import Style from './style.css'
import Tabs from '../components/Tabs.vue'

export default {
  ...DefaultTheme,
  Layout,
  enhanceApp({ app }) {
    app.component('Tabs', Tabs)
  }
}
```

--------------------------------

### Custom Footer Component

Source: https://github.com/kyma-project/kyma/blob/main/docs/vitepress-structure.md

A custom footer component for VitePress that includes copyright information and legal links. It uses scoped CSS for styling.

```vue
<template>
  <footer>
    <p>&copy; 2018-2025 Kyma Project Authors.</p>
    <nav>
      <a href="#">Terms of Use</a> |
      <a href="#">Privacy Statement</a> |
      <a href="#">Legal Disclosure</a>
    </nav>
  </footer>
</template>

<style scoped>
footer {
  text-align: center;
  padding: 20px;
  border-top: 1px solid #eee;
  margin-top: 40px;
}
</style>
```

--------------------------------

### Delete Kyma Module Manager

Source: https://github.com/kyma-project/kyma/blob/main/docs/02-get-started/08-uninstall-upgrade-kyma-module.md

After deleting a module's custom resource, use this command to remove the module manager. This helps prevent leftover resources.

```bash
kubectl delete {PATH_TO_THE_MODULE_MANAGER_YAML_FILE}
```

--------------------------------

### Tab Content Wrapper Component

Source: https://github.com/kyma-project/kyma/blob/main/docs/vitepress-structure.md

A simple Vue component that acts as a wrapper for individual tab content. It is designed to work with the `Tabs.vue` component.

```vue
<template>
  <div>
    <slot></slot>
  </div>
</template>

<script setup>
// This component is primarily a structural element for the Tabs component.
// No specific logic is required here as its content is managed by the parent Tabs component.
</script>
```

--------------------------------

### Kyma Custom CSS Variables

Source: https://github.com/kyma-project/kyma/blob/main/docs/vitepress-structure.md

Defines custom CSS variables for Kyma branding and UI elements. Includes primary colors, font families, and specific element styles.

```css
:root {
  --vp-font-family-base: 'SAP 72', sans-serif;
  --vp-font-family-code: 'SAP Mono', monospace;
  --vp-color-brand: #0b74de;
  --vp-color-brand-light: #2196f3;
  --vp-color-brand-dark: #0a549d;
  --vp-color-tip-text: #0b74de;
  --vp-color-warning-text: #ffb300;
  --vp-color-danger-text: #d32f2f;
}

button {
  background-color: var(--vp-color-brand);
}

.home-hero {
  background: linear-gradient(135deg, var(--vp-color-brand), var(--vp-color-brand-dark));
}
```

--------------------------------

### kubectl Port Forwarding Error

Source: https://github.com/kyma-project/kyma/blob/main/docs/04-operation-guides/troubleshooting/01-kube-troubleshoot-kubectl-port-forward.md

This error occurs when the local port is already in use by another process. To resolve this, you can terminate the conflicting process, select an alternative port, or allow kubectl to automatically assign an available port.

```bash
Unable to listen on port ... bind: address already in use
```

--------------------------------

### Transform Sidebar Paths in VitePress

Source: https://github.com/kyma-project/kyma/blob/main/docs/vitepress-structure.md

Transforms relative sidebar paths to absolute paths for VitePress. This function is crucial for correctly loading sidebar configurations from different modules.

```javascript
function makeSidebarAbsolutePath(sidebar) {
  return sidebar.map(item => {
    if (item.link) {
      item.link = `/Kyma${item.link}`;
    }
    if (item.children) {
      item.children = makeSidebarAbsolutePath(item.children);
    }
    return item;
  });
}
```

--------------------------------

### Kyma Domain Resolution Error Message

Source: https://github.com/kyma-project/kyma/blob/main/docs/04-operation-guides/troubleshooting/01-kyma-domain-unresolvable.md

This is the error message you may encounter when the Kyma domain is not resolvable. It suggests checking DNS resolver settings and potentially updating your hosts file.

```bash
The configured Kyma domain {DOMAIN} is not resolvable. This could be due to activated rebind protection of your DNS resolver. Please add virtual service domains to your hosts file.
```

--------------------------------

### Tabs Component

Source: https://github.com/kyma-project/kyma/blob/main/docs/vitepress-structure.md

An advanced Vue component for creating tabbed interfaces. It accepts tab data via a prop and renders multiple tabs with content.

```vue
<template>
  <div class="tabs-container">
    <div class="tabs-header">
      <button 
        v-for="(tab, index) in tabs"
        :key="index"
        @click="activeTab = index"
        :class="{ active: activeTab === index }"
      >
        {{ tab.title }}
      </button>
    </div>
    <div class="tabs-content">
      <div v-html="currentTabContent"></div>
    </div>
  </div>
</template>

<script setup>
import { ref, computed } from 'vue'

const props = defineProps({
  tabsData: {
    type: Array,
    required: true
  }
})

const activeTab = ref(0)

const currentTabContent = computed(() => {
  if (!props.tabsData || props.tabsData.length === 0) return '';
  const decodedContent = atob(props.tabsData[activeTab.value].text);
  // In a real scenario, you might want to render markdown here
  return decodedContent;
})

const tabs = computed(() => props.tabsData.map(tab => ({ title: tab.title })))
</script>

<style>
.tabs-container { /* styles */ }
.tabs-header { /* styles */ }
.tabs-header button { /* styles */ }
.tabs-header button.active { /* styles */ }
.tabs-content { /* styles */ }
</style>
```

--------------------------------

### Disable a Makefile Rule

Source: https://github.com/kyma-project/kyma/blob/main/common/makefiles/docs/generic-make-go.md

To disable a specific rule in a local Makefile, append a semicolon `;` after the rule name. This will prevent the rule from executing while still showing a warning in the console.

```makefile
{RULE}: ;
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.