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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BUG] The README.md in longhorn-manager is outdated #6914

Closed
votdev opened this issue Oct 17, 2023 · 3 comments
Closed

[BUG] The README.md in longhorn-manager is outdated #6914

votdev opened this issue Oct 17, 2023 · 3 comments
Assignees
Labels
area/dev Development related kind/bug priority/0 Must be fixed in this release (managed by PO)
Milestone

Comments

@votdev
Copy link

votdev commented Oct 17, 2023

Describe the bug (馃悰 if you encounter this issue)

The README.md is not up-to-date and contains information that are not helpful anymore.

E.g. the Deployment section contains is mentioning the kubectl create -Rf deploy/install command which points to a directory which does not exist in the GH repository. It seems it exist in the longhorn repository now.

But even then it is not helpful, because the subdirectory /deploy/install/ does not exist. The same applies to the uninstallation, the directory /deploy/uninstall/ does not exist either.

Additionally it would be helpful to mention what the outcome of the make in the Build section is.

To Reproduce

Go to https://github.com/longhorn/longhorn-manager.

Expected behavior

The documentation is up-to-date to support new users and give them the necessary information.

@votdev votdev added kind/bug area/dev Development related labels Oct 17, 2023
@innobead innobead added this to the v1.6.0 milestone Oct 17, 2023
@innobead innobead modified the milestones: v1.6.0, v1.7.0 Dec 13, 2023
@innobead innobead added the priority/0 Must be fixed in this release (managed by PO) label Dec 13, 2023
@innobead innobead assigned c3y1huang and unassigned james-munson Dec 13, 2023
@innobead innobead assigned mantissahz and unassigned c3y1huang Feb 26, 2024
@innobead
Copy link
Member

Suggest checking other repos as well and creating corresponding tickets for them.

@longhorn-io-github-bot
Copy link

longhorn-io-github-bot commented May 9, 2024

Pre Ready-For-Testing Checklist

@mantissahz
Copy link
Contributor

README.md has been updated.

Hi @votdev,
Feel free to reopen if you have any concerns.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/dev Development related kind/bug priority/0 Must be fixed in this release (managed by PO)
Projects
Status: Resolved/Scheduled
Development

No branches or pull requests

6 participants