Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

remove redundant description for debug procedure, instead using link. #661

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

fujitatomoya
Copy link
Contributor

@fujitatomoya fujitatomoya commented Jan 16, 2025

  • Please check if the PR fulfills these requirements
  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

Which issue(s) this PR fixes:

Fixes part of kubeedge/kubeedge#6030, in particular kubeedge/kubeedge#6030 (comment)

  • What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)

Removes redundant debug procedure and explanation, keep the up-to-date procedure and use ref links instead.

  • What is the current behavior? (You can also link to an open issue here)

Redundant documentation increases the maintenance cost.

  • What is the new behavior (if this is a feature change)?

Keep the latest information and using links instead.

  • Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)

Not at all.

  • Other information:

N.A

@kubeedge-bot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign dingyin after the PR has been reviewed.
You can assign the PR to them by writing /assign @dingyin in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kubeedge-bot kubeedge-bot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Jan 16, 2025
@fujitatomoya
Copy link
Contributor Author

@1Shubham7 since you seems to be interested in documentation development and enhancement, i could use some review from you?

Copy link
Contributor Author

@fujitatomoya fujitatomoya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I gotta ask for some help for Chinese version. i tried to do the same fixes in there, but not 100% sure that i did that properly.

docs/advanced/debug.md Show resolved Hide resolved
docs/setup/install-with-binary.md Show resolved Hide resolved
docs/setup/install-with-keadm.md Show resolved Hide resolved
docs/setup/install-with-keadm.md Show resolved Hide resolved
docs/setup/install-with-keadm.md Show resolved Hide resolved
Copy link
Contributor

@1Shubham7 1Shubham7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @fujitatomoya, I just like contributing to the project as much as I can (these days I am not getting time to make code contributions). I plan to contribute more to code and not docs but I have reviewed this one : )
(only the english version part)

docs/advanced/debug.md Outdated Show resolved Hide resolved
docs/advanced/debug.md Outdated Show resolved Hide resolved
docs/advanced/debug.md Outdated Show resolved Hide resolved
docs/advanced/debug.md Outdated Show resolved Hide resolved
docs/advanced/debug.md Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants