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

Docs: Improving the install with binary docs #558

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

Conversation

1Shubham7
Copy link
Contributor

@1Shubham7 1Shubham7 commented May 30, 2024

  • 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)
  • What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
    docs update

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

this is one among series of PRs planned to improve and rewrite some parts of documentation. Here I improved the "install with binary" docs.

Works towards solving #533

@kubeedge-bot kubeedge-bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label May 30, 2024
@1Shubham7
Copy link
Contributor Author

@wbc6080 @fujitatomoya I am looking for your suggestions here as well.

Copy link
Contributor

@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.

the fix lgtm with a couple of minor nitpics.

btw, why do we need to maintain? this is not even recommended procedure to install KubeEdge, what is the use case for this procedure? even with testing environment, we should not set up the KubeEdge with binaries? if that is so, probably we can just remove this page? i may be missing some cases, not sure about the history...

docs/setup/install-with-binary.md Outdated Show resolved Hide resolved
docs/setup/install-with-binary.md Outdated Show resolved Hide resolved
@1Shubham7 1Shubham7 changed the title Docs: Improving the "install with binary" documentation Docs: Improving the install with binary docs Jun 1, 2024
@1Shubham7
Copy link
Contributor Author

the fix lgtm with a couple of minor nitpics.

btw, why do we need to maintain? this is not even recommended procedure to install KubeEdge, what is the use case for this procedure? even with testing environment, we should not set up the KubeEdge with binaries? if that is so, probably we can just remove this page? i may be missing some cases, not sure about the history...

@wbc6080 @fisherxu what are your views?

Copy link
Contributor

@wbc6080 wbc6080 left a comment

Choose a reason for hiding this comment

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

This part is mainly for developers. After modifying some codes of kubeedge, you can directly start the kubeedge cluster in binary mode for testing. I think it is necessary to keep this part, otherwise developers will not be able to check whether the subsequent kubeedge can work normally after the modifications.

@1Shubham7
Copy link
Contributor Author

1Shubham7 commented Jun 6, 2024

added all your suggestions, Please also confirm that we are only using beta version of device crd and other crds need not be updated.

@fujitatomoya
Copy link
Contributor

This part is mainly for developers. After modifying some codes of kubeedge, you can directly start the kubeedge cluster in binary mode for testing. I think it is necessary to keep this part, otherwise developers will not be able to check whether the subsequent kubeedge can work normally after the modifications.

@wbc6080 thanks for clarification.

Copy link
Contributor

@wbc6080 wbc6080 left a comment

Choose a reason for hiding this comment

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

/lgtm

@kubeedge-bot kubeedge-bot added the lgtm Indicates that a PR is ready to be merged. label Jun 7, 2024
@1Shubham7
Copy link
Contributor Author

@fujitatomoya @wbc6080 please approve this PR :)

Copy link
Contributor

@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.

lgtm. (i do not have the permission though...)

Copy link
Contributor

@wbc6080 wbc6080 left a comment

Choose a reason for hiding this comment

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

You can wait for an approver to merge it

@kubeedge-bot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: fujitatomoya, wbc6080
To complete the pull request process, please assign shelley-baoyue after the PR has been reviewed.
You can assign the PR to them by writing /assign @shelley-baoyue 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 removed the lgtm Indicates that a PR is ready to be merged. label Sep 9, 2024
@kubeedge-bot
Copy link
Collaborator

New changes are detected. LGTM label has been removed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants