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

Eliminate duplication between readmes #1159

Open
t1m0thyj opened this issue Oct 1, 2021 · 1 comment
Open

Eliminate duplication between readmes #1159

t1m0thyj opened this issue Oct 1, 2021 · 1 comment
Labels
documentation priority-low Legit issue but cosmetic or nice-to-have

Comments

@t1m0thyj
Copy link
Member

t1m0thyj commented Oct 1, 2021

Currently there is a lot of overlap between the contents of the readme at the root of the repo (/README.md), and the readme for the Zowe CLI package (/packages/cli/README.md).

They have already fallen out of sync, with some changes made in just one file that should have been made in both.

I'm not sure exactly how the content should be split up, but believe we should update the readmes to contain distinct content geared to separate audiences. The readme at the root the repo has more visibility to CLI developers who find the CLI repository on GitHub, while the readme for the CLI package is shown to a wider audience on npmjs.com.

@t1m0thyj t1m0thyj added enhancement New feature or request priority-low Legit issue but cosmetic or nice-to-have labels Nov 3, 2022
@github-actions
Copy link

github-actions bot commented Nov 3, 2022

Thank you for raising this issue.
The community has 90 days to upvote 👍 the issue.
If it receives 5 upvotes, we will move it to our backlog. If not, we will close it.

@t1m0thyj t1m0thyj removed the enhancement New feature or request label Nov 3, 2022
@ATorrise ATorrise linked a pull request Dec 1, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation priority-low Legit issue but cosmetic or nice-to-have
Projects
Status: Low Priority
Development

Successfully merging a pull request may close this issue.

2 participants