[DOCS-3817] Minor README improvements Created: 25/Jul/14 Updated: 11/Jan/17 Resolved: 28/Aug/14 |
|
| Status: | Closed |
| Project: | Documentation |
| Component/s: | manual |
| Affects Version/s: | None |
| Fix Version/s: | 01112017-cleanup |
| Type: | Improvement | Priority: | Trivial - P5 |
| Reporter: | Michael Mattioli | Assignee: | Barrie Segal |
| Resolution: | Done | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Participants: | |
| Days since reply: | 9 years, 24 weeks, 6 days ago |
| Description |
|
I was taking a look at the GitHub README files in the pymongo driver repo and the core server repo and they could be formatted a pinch nicer and easier so that users can easily jump to install commands and differentiate between what is actual text or an explanation and what is a command line argument or piece of example code. These are minor changes but I think they'll definitely help. I was wondering if it's OK to make the changes and submit pulls but wanted to ask here first to check if there was some sort of formal process (aside from opening a JIRA ticket) for doing do. |
| Comments |
| Comment by Sam Kleinman (Inactive) [ 28/Aug/14 ] |
|
I hope this answers the question, I don't think there's a continuing use for this ticket. If you have any more questions feel free to reopen or open another ticket. |
| Comment by Barrie Segal [ 19/Aug/14 ] |
|
You're welcome to submit a PR with any suggested changes for the github README docs; you don't need to open a JIRA ticket. Thanks Michael! |