[CXX-764] Move quickstart guide from wiki to README.md file Created: 04/Dec/15  Updated: 09/Sep/16  Resolved: 09/Sep/16

Status: Closed
Project: C++ Driver
Component/s: Documentation
Affects Version/s: None
Fix Version/s: None

Type: Improvement Priority: Major - P3
Reporter: David Daly Assignee: David Golden
Resolution: Duplicate Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   

The instructions for building the driver and the prerequisites only exist on the wiki currently. It would be nice to have that included in the repo itself.



 Comments   
Comment by David Golden [ 09/Sep/16 ]

We'll address this as part of the docs overhaul in CXX-1000

Comment by Andrew Morrow (Inactive) [ 07/Jan/16 ]

The problem is that we definitely want the instructions on the wiki, and we don't want them in two places since they will diverge.

Comment by David Daly [ 07/Jan/16 ]

acm The short answer is I tried to build the driver on my laptop while sitting on a train without internet access and didn't have the wiki previously open. In general, it would be nice to have the build instructions in the repo itself removing one cognitive step in the process. It doesn't have to be the REAME.md itself. A separate markdown file would work also.

Comment by Tess Avitabile (Inactive) [ 07/Jan/16 ]

Fixed the broken link in the legacy README.

Comment by Andrew Morrow (Inactive) [ 07/Jan/16 ]

No, the wiki link on legacy should go to the "download and compile" wiki page. The one on master should go to the quick start guide.

david.daly - Can you clarify why you wanted us to move the build instructions into the readme page?

Comment by Tess Avitabile (Inactive) [ 07/Jan/16 ]

Whoops, sorry, yes, I was on legacy! Should that link go to the same wiki page as the one in master?

Comment by Andrew Morrow (Inactive) [ 07/Jan/16 ]

Actually though, I'm not 100% sure we should do this. The build instructions are going to get huge. I'm not sure it makes sense to have them in the README

Comment by Andrew Morrow (Inactive) [ 07/Jan/16 ]

I think that is just a broken link on the legacy branch README.md. If you could fix that it would be great. But remember to switch to the master branch when you go to github, because it isn't the default. From there, the wiki link does take you to the quick start guide.

Generated at Wed Feb 07 22:00:15 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.