Fix:Addessed issues in README #1063
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
There are still issues need to address in README.md and these are;
|
|
Thanks for getting this started, @LanieOkorodudu! A couple suggested next steps: 1.) Change the URL https://github.com/UniversalViewer/universalviewer/blob/master/LICENSE.txt to https://github.com/UniversalViewer/universalviewer/blob/main/LICENSE.txt 2.) Under "Getting Started" I would change the docs link to https://docs.universalviewer.io/modules.html and maybe rephrase the whole sentence to something like "Read the technical docs to learn more about the code and available configuration options." A bigger issue to discuss/think about: the Contributing section references (and links to) a number of issue labels, but none of these labels are currently being used. Should we either make an effort to start labeling issues, or should we remove/reduce this section of the README? Right now it just contributes to a feeling that parts of the project have been abandoned. Maybe for now the best thing to do is remove all the sub-bullets, and link "issue" in "Find an issue to work on and submit a pull request" to https://github.com/UniversalViewer/universalviewer/issues. |
|
Thanks @demiankatz for your suggestions. Regarding the Contributing section, I agree that the current references to issue labels can be misleading since they are not being used. As you mentioned, I think this should be discussed and agreed upon in the next SG meeting, whether we should remove or reduce this section of the README. Do you recommend that I update the link as you suggested now, or should I wait until the Contributing section is finalized? |
I think it's likely that we'll agree to the changes, so I don't think there's any harm in making the edits now. Then we can discuss and, if we agree, merge during the next meeting. (And if we don't agree, it's not hard to undo controversial changes). Thanks again! |
Do you think this link should be remove since they are not being used. First time contributing to the UV? Pick a beginner friendly issue to get you familiar with codebase and our contributing process. |
Yes, that would be my suggestion. Keep the top-level bullet, with an added link to the issues page, and then just delete all the sub-bullets below it that link to specific labels. |
1.) Change the URL https://github.com/UniversalViewer/universalviewer/blob/master/LICENSE.txt to https://github.com/UniversalViewer/universalviewer/blob/main/LICENSE.txt 2.) Under "Getting Started" I would change the docs link to https://docs.universalviewer.io/modules.html and maybe rephrase the whole sentence to something like "Read the technical docs to learn more about the code and available 3.) Added link to "Find an issue to work on and submit a pull request" to https://github.com/UniversalViewer/universalviewer/issues. 4.) deleted all the sub-bullets below it that link to specific labels
I have made the changes as you suggested. The top-level bullet now includes a link to the issues page, and all the sub-bullets that linked to specific labels have been removed. Could you please review the changes to confirm if they are what you had in mind? |
|
Thanks, @LanieOkorodudu! I would perhaps change: to: |
Okay this make sense 💯 agree with you. Thanks again @demiankatz, I really appreciate your help 😃 |
|
Looks good to me now! Thanks again, @LanieOkorodudu. |
|
Thanks again, @LanieOkorodudu! I just noticed that this PR was targeted to main instead of dev; we should try to get in the habit of merging things to dev first. Fortunately, no harm done here -- I just merged main backwards to dev to get things back in sync again. :-) |
oh my bad. I should have ask you first before merging. Thanks for letting me know. |
I started to address these README issues;
Twitter - change to X, move to after link for slack
Website - should include link to https://universalviewer.io/