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] Refinement of Readme.md #301

Open
vasudev-sharma opened this issue Nov 22, 2019 · 3 comments
Open

[Docs] Refinement of Readme.md #301

vasudev-sharma opened this issue Nov 22, 2019 · 3 comments

Comments

@vasudev-sharma
Copy link

vasudev-sharma commented Nov 22, 2019

I saw a lot of PR's and issues on readme doc. Some of them have been partially completed and some have been not been reviewed or merged. Moreover, some of the PR's related to readme have became outdated and stale because of contributions made by the past developers had made them irrelevant due to recent changes.

Hence,I think we should formulate a clear and systematic approach to properly document readme doc.

Description

  1. First, I would like to point some issues regarding documentation under the heading Installing Docker, I believe from a point of installation, this documentation is quite unstructured. A structured approach ( either in the form of bullets or numerals ) would give more clarity and sense.

Screenshot 2019-11-23 at 2 25 07 AM

Additionally there should be proper referencing of the instructions given under Installing Docker. For example skip step 3 should be referencing to docker installation step 3 url page.

  1. Secondly, I think when a user clicks under windows installation guidelines given in the readme doc, it makes the doc too long. I believe we should redirect it to another documentation file related to windows installation guidelines, this will make the doc look cleaner.

Screenshot 2019-11-23 at 2 55 19 AM

Additional note

These are just 2 doc changes which I thought to mention, to get the discussion started on this issue. There might be more changes which could be included in this issue so I will look for a more changes in the readme doc and will update in this issue.

Just one question, what do the maintainers think about this ?

Thanks!

@hacky1997
Copy link

me

@bosecodes
Copy link

I'd like to work on this! @vs74

@SD007CSE
Copy link

Please review my PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants