К основному содержанию
правило

kubernetes-mkdocs-documentation-cursorrules-prompt — правило

Правило задаёт Cursor роль технического писателя: агент пишет документацию по Kubernetes и cloud native в Markdown и MkDocs.

Установить в Cursor · Вручную: положить файлы Все способы и платформы ↓
.cursor/rules/kubernetes-mkdocs-documentation-cursorrules-prompt.mdc
Открыть на GitHub

Что делает kubernetes-mkdocs-documentation-cursorrules-prompt

Правило включается в Cursor и меняет поведение агента при работе с документацией. Он ведёт себя как технический писатель, который разбирается в Kubernetes и cloud native, и опирается на актуальные стабильные версии Kubernetes, cloud native-инструментов и MkDocs.

Внутри файла — набор разделов: стиль и структура документации, работа с MkDocs, создание контента, техническая точность, метаданные и SEO, совместная работа и контроль версий. Отдельно оговорено, что документация должна быть полной и точной по всем запрошенным темам, без отговорок.

В frontmatter стоит globs: **/*, то есть правило видит любой файл проекта, а alwaysApply: false — оно не подключается само. Это повод проверить: если вы ждали, что Cursor начнёт следовать правилу сразу после установки, ничего не произойдёт, пока вы не включите его вручную.

Какие задачи решает

  • описать новый сервис Kubernetes так, чтобы текст понял человек без опыта с кластерами
  • собрать структуру разделов для сайта документации на MkDocs
  • привести разрозненные заметки к единому стилю Markdown
  • проверить, что в тексте нет устаревших версий Kubernetes и cloud native-инструментов
  • заполнить метаданные страниц для поисковой выдачи

Примеры запросов агенту

  • Опиши манифесты Deployment и Service для нового сервиса и добавь страницу в docs/
  • Собери структуру раздела про networking в MkDocs и напиши черновик
  • Проверь страницу docs/install.md: версии Kubernetes актуальные, стиль ровный?

Как установить kubernetes-mkdocs-documentation-cursorrules-prompt

Вручную: положить файлы

.cursor/rules/kubernetes-mkdocs-documentation-cursorrules-prompt.mdc

Во frontmatter: description, globs, alwaysApply

По шагам, с командами для каждой платформы: Cursor rules: файлы .mdc, четыре режима и замена .cursorrules

Вопросы о kubernetes-mkdocs-documentation-cursorrules-prompt

Как установить kubernetes-mkdocs-documentation-cursorrules-prompt в Cursor?

Положите файл по пути .cursor/rules/kubernetes-mkdocs-documentation-cursorrules-prompt.mdc. После этого включите правило вручную: в frontmatter стоит alwaysApply: false.

Что делает это правило?

Задаёт агенту роль технического писателя по Kubernetes и cloud native. Он пишет и правит документацию в Markdown и MkDocs, следит за стилем, метаданными и актуальностью версий.

На какие файлы оно распространяется?

На все: в frontmatter указано globs: **/*. Правило может сработать и на файлах кода, а не только на страницах документации.

Исходный текст

kubernetes-mkdocs-documentation-cursorrules-prompt.mdc · CC0-1.0
---
description: "Cursor rules for Kubernetes development with MkDocs documentation integration."
globs: **/*
alwaysApply: false
---
You are an expert Technical Writer with a deep understanding of cloud native technologies, Kubernetes, and technical documentation best practices. You excel at creating clear, concise, and user-friendly documentation using Markdown and MkDocs.

You always use the latest stable versions of Kubernetes, cloud native tools, and MkDocs. You're familiar with the latest features, best practices, and trends in cloud native architecture, containerization, and orchestration.

Documentation Style and Structure:

Cloud Native and Kubernetes Expertise:

MkDocs Usage:

Content Creation:

Technical Accuracy and Usability:

Documentation Best Practices:

Metadata and SEO:

Collaboration and Version Control:

Other Rules to follow:

Don't be lazy, provide thorough and accurate documentation for all requested topics and features.

© PatrickJS · CC0-1.0 · PatrickJS/awesome-cursorrules

Похожие правила IDE

Всё по теме «Тексты и документация» →
mkdocs-translations официальный github Переводит всю документацию MkDocs на заданный язык: копирует структуру папок, сохраняет Markdown и правит конфиг i18n. Пригодится, если у вас docs на английском, а нужна ещё пара локалей. 8 800установок kubernetes-specialist https://github.com/Jeffallan Скилл помогает создавать и проверять Kubernetes-манифесты, настраивать безопасность и разбирать сбои подов. Пригодится для деплоя и сопровождения кластерных workloads. CX Codex +1 14 100установок kubernetes-pentesting yaklang Плейбук по пентесту Kubernetes: доступ к API-серверу, перебор RBAC, злоупотребление токенами service account, etcd, Kubelet API и побег из пода. CX Codex +1 3 700установок dt-obs-kubernetes Dynatrace Скилл помогает анализировать состояние кластеров Kubernetes, сбои подов и нехватку ресурсов через запросы Dynatrace DQL. CX Codex +1 2 600установок tao-run-on-kubernetes NVIDIA Corporation Отправляет контейнерные джобы TAO в Kubernetes как обычные Job через kubectl. Нужен, когда обучение или инференс надо запускать на EKS, GKE, AKS или своём кластере с GPU. CX Codex +1 1 600установок kubernetes-skill LukasNiessen Помогает создавать и проверять манифесты Kubernetes без галлюцинаций. Находит ошибки в безопасности, сетевых политиках и ресурсах. CX Codex +1 1 400установок

Из того же набора68

netlify-official-cursorrules-prompt-file Правило для Cursor, которое задаёт агенту официальные соглашения Netlify: типы функций, работа с окружением и запрет лишних CORS-заголовков. ★ 41 011звёзд репо nativescript-cursorrules-prompt-file Правило Cursor, которое задаёт агенту структуру проекта и стек для NativeScript: TypeScript, навигация, защищённое хранилище. ★ 41 011звёзд репо manifest-yaml-cursorrules-prompt-file Правило задаёт Cursor, как собирать лёгкий демо-бэкенд на Manifest: структура проекта, файл manifest/backend.yml и ограничения по сущностям. ★ 41 011звёзд репо laravel-php-83-cursorrules-prompt-file Правило для Cursor, которое ведёт агента по разработке пакетов Laravel: структура, стандарты кода, тесты и документация. ★ 41 011звёзд репо knative-istio-typesense-gpu-cursorrules-prompt-fil Правило для Cursor, которое превращает ассистента в помощника по serverless-проектам на Knative с Istio, Typesense и HTMX. Пригодится, если вы собираете поисковое приложение на этих технологиях. ★ 41 011звёзд репо javascript-chrome-apis-cursorrules-prompt-file Правило для Cursor, которое настраивает ИИ-агента на разработку расширений Chrome: манифест, архитектура, работа с Chrome API. ★ 41 011звёзд репо htmx-go-fiber-cursorrules-prompt-file Правило Cursor для проектов на Go с Fiber и HTMX: задаёт структуру папок, роутинг и работу с шаблонами, чтобы агент не изобретал своё. ★ 41 011звёзд репо htmx-django-cursorrules-prompt-file Правило для Cursor, которое задаёт агенту привычки Django при работе с HTMX: шаблоны, формы, CSRF, class-based views. ★ 41 011звёзд репо

Спонсоры проекта

Компании, которые помогают держать аналитику открытой