diff --git a/.github/workflows/check-docs.yml b/.github/workflows/check-docs.yml index d6dfe6c2bf..bf29c0f366 100644 --- a/.github/workflows/check-docs.yml +++ b/.github/workflows/check-docs.yml @@ -39,4 +39,4 @@ jobs: - name: Verify that the markdown is valid run: | - yarn run mkdocs-verify + yarn run verify-docs diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index a282cad912..9ca4a66b14 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -43,7 +43,7 @@ jobs: - name: Verify that the markdown is valid run: | - yarn run mkdocs-verify + yarn run verify-docs - name: Generate Extensions API Reference using typedocs run: | diff --git a/docs/extensions/README.md b/docs/extensions/README.md index afece3a12a..7866b65497 100644 --- a/docs/extensions/README.md +++ b/docs/extensions/README.md @@ -14,7 +14,7 @@ Here are some examples of what you can achieve with the Extension API: * Add custom components & views in the UI - Extending the Lens Workbench -For an overview of the Lens Extension API, refer to the [Common Capabilities](capabilities/common-capabilities.md) page. [Extension Guides Overview](guides/overview.md) also includes a list of code samples and guides that illustrate various ways of using the Lens Extension API. +For an overview of the Lens Extension API, refer to the [Common Capabilities](capabilities/common-capabilities.md) page. [Extension Guides Overview](guides/README.md) also includes a list of code samples and guides that illustrate various ways of using the Lens Extension API. ## How to Build Extensions diff --git a/docs/extensions/guides/anatomy.md b/docs/extensions/guides/anatomy.md new file mode 100644 index 0000000000..cc7b84e256 --- /dev/null +++ b/docs/extensions/guides/anatomy.md @@ -0,0 +1,3 @@ +--- +WIP +--- diff --git a/docs/extensions/guides/components.md b/docs/extensions/guides/components.md new file mode 100644 index 0000000000..cc7b84e256 --- /dev/null +++ b/docs/extensions/guides/components.md @@ -0,0 +1,3 @@ +--- +WIP +--- diff --git a/docs/extensions/guides/kube-object-list-layout.md b/docs/extensions/guides/kube-object-list-layout.md new file mode 100644 index 0000000000..cc7b84e256 --- /dev/null +++ b/docs/extensions/guides/kube-object-list-layout.md @@ -0,0 +1,3 @@ +--- +WIP +--- diff --git a/docs/extensions/guides/stores.md b/docs/extensions/guides/stores.md new file mode 100644 index 0000000000..cc7b84e256 --- /dev/null +++ b/docs/extensions/guides/stores.md @@ -0,0 +1,3 @@ +--- +WIP +--- diff --git a/package.json b/package.json index 5e1fafa55a..50aa0598f2 100644 --- a/package.json +++ b/package.json @@ -40,7 +40,7 @@ "lint": "yarn run eslint $@ --ext js,ts,tsx --max-warnings=0 src/ integration/ __mocks__/ build/ extensions/", "lint:fix": "yarn run lint --fix", "mkdocs-serve-local": "docker build -t mkdocs-serve-local:latest mkdocs/ && docker run --rm -it -p 8000:8000 -v ${PWD}:/docs mkdocs-serve-local:latest", - "mkdocs-verify": "docker build -t mkdocs-serve-local:latest mkdocs/ && docker run --rm -v ${PWD}:/docs mkdocs-serve-local:latest build --strict", + "verify-docs": "docker build -t mkdocs-serve-local:latest mkdocs/ && docker run --rm -v ${PWD}:/docs mkdocs-serve-local:latest build --strict", "typedocs-extensions-api": "yarn run typedoc --ignoreCompilerErrors --readme docs/extensions/typedoc-readme.md.tpl --name @k8slens/extensions --out docs/extensions/api --mode library --excludePrivate --hideBreadcrumbs --includes src/ src/extensions/extension-api.ts" }, "config": {