docs: update Device CRDs documentation and fix broken link#728
docs: update Device CRDs documentation and fix broken link#728sachin21212121 wants to merge 1 commit intokubeedge:masterfrom
Conversation
sachin21212121
commented
Sep 25, 2025
sachin21212121
commented
- Fixed the broken link to the device-crd-v1beta1 proposal.
- Improved clarity and formatting of Device CRDs documentation.
- Added explanations for YAML fields and usage steps.
- Documentation-only update; no functional changes.
Signed-off-by: sachin21212121 <jhasachin0115@gmail.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
Summary of ChangesHello @sachin21212121, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on enhancing the documentation for KubeEdge Device CRDs, specifically for the Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
kubeedge-bot
added
the
size/L
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request significantly improves the documentation for Device CRDs by clarifying concepts, fixing a broken link, and providing better examples and usage instructions. The changes enhance readability and make the documentation more user-friendly. I've provided a couple of suggestions to further improve the markdown structure and formatting for better consistency and semantic correctness.
| KubeEdge supports device management with the help of Kubernetes [CRDs](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions) and Device Mapper corresponding to the device being used. | ||
| We currently use Device Model and Device Instance to define the device. | ||
|
|
||
| # **Device CRDs** |
There was a problem hiding this comment.
The use of bold markdown (**...**) inside a level-1 heading is unconventional and may not render as expected across all markdown parsers. It's generally better to keep headings clean for semantic correctness and consistent rendering. Please remove the bold formatting from the heading.
| # **Device CRDs** | |
| # Device CRDs |
| 1. ### Create a Device Model | ||
|
|
||
| 1. Create a device model, execute in the cloud node. | ||
| Apply the Device Model YAML file to the cluster: | ||
|
|
||
| ```shell | ||
| kubectl apply -f <path to device model yaml> | ||
| ```bash | ||
| kubectl apply -f <path-to-device-model-yaml> | ||
| ``` | ||
|
|
||
| 2. Create a device instance, execute in the cloud node. | ||
| ```shell | ||
| kubectl apply -f <path to device instance yaml> | ||
| Verify the Device Model creation: | ||
|
|
||
| ```bash | ||
| kubectl get devicemodels | ||
| ``` | ||
|
|
||
| 2. ### Create a Device Instance | ||
|
|
||
| Apply the Device Instance YAML file to the cluster: | ||
|
|
||
| ```bash | ||
| kubectl apply -f <path-to-device-instance-yaml> | ||
| ``` | ||
|
|
||
| Verify the Device Instance creation: | ||
|
|
||
| ```bash | ||
| kubectl get devices | ||
| ``` |
There was a problem hiding this comment.
Using headings within a numbered list is unconventional and can lead to inconsistent rendering or awkward formatting. For better document structure and readability, it's recommended to use headings for each step directly, rather than nesting them inside a list. This makes the steps clearer and easier to navigate.
### 1. Create a Device Model
Apply the Device Model YAML file to the cluster:
```bash
kubectl apply -f <path-to-device-model-yaml>Verify the Device Model creation:
kubectl get devicemodels2. Create a Device Instance
Apply the Device Instance YAML file to the cluster:
kubectl apply -f <path-to-device-instance-yaml>Verify the Device Instance creation:
kubectl get devices
|
Hello 👋 Looks like there was no activity on this amazing PR for last 90 days. Do you mind updating us on the status? Is there anything we can help with? If you plan to still work on it, just comment on this PR or push a commit. Thanks! 🤗 If there will be no activity for 60 days, this PR will be closed (we can always reopen a PR if you get back to this!). |
fujitatomoya
left a comment
fujitatomoya
left a comment
There was a problem hiding this comment.
overall lgtm, comments need to be resolved.
|
|
||
| We define devices using two primary resources: **Device Model** and **Device Instance**. | ||
|
|
||
| --- |
There was a problem hiding this comment.
why do we want to add the separator in the description?
| KubeEdge supports device management with the help of Kubernetes [CRDs](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions) and Device Mapper corresponding to the device being used. | ||
| We currently use Device Model and Device Instance to define the device. | ||
|
|
||
| # **Device CRDs** |
| properties: | ||
| - name: temp | ||
| description: beta1-model | ||
| description: Temperature attribute |
There was a problem hiding this comment.
good catch, this aligns with the example DeviceModel description 👍
3 participants
