[NCBC-303] Add intro to .NET SDK guides Created: 24/Sep/13  Updated: 01/Oct/13  Resolved: 01/Oct/13

Status: Resolved
Project: Couchbase .NET client library
Component/s: docs
Affects Version/s: 1.0, 1.1, 1.2.0
Fix Version/s: 1.0, 1.1, 1.2.0

Type: Task Priority: Minor
Reporter: Amy Kurtzman Assignee: Gwen Leong (Inactive)
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   
The SDK guides currently begin with the Getting Started section. They need an introduction and meaningful web page title so customers know what guide they are reading.

For each version of the SDK guide, please:

1. Add a short introduction (# Introduction) before the Getting Started section. Sample intro:
    This guide provides information for developers who want to use the Couchbase <language> SDK to
    build applications that use Couchbase Server.

2. In the corresponding index.erb file, change the title to one that follows this naming pattern:
    Couchbase <language> SDK <version> Guide

 Comments   
Comment by Gwen Leong (Inactive) [ 01/Oct/13 ]
Added to all versions.
http://docs.couchbase.com/couchbase-sdk-net-1.2/




[NCBC-94] code formatting is unreadable in documentation Created: 06/Aug/12  Updated: 06/Aug/12  Resolved: 06/Aug/12

Status: Closed
Project: Couchbase .NET client library
Component/s: docs
Affects Version/s: None
Fix Version/s: 1.1

Type: Bug Priority: Minor
Reporter: Matt Ingenthron Assignee: Unassigned
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   
See http://www.couchbase.com/docs/couchbase-sdk-net-1.1/getting-started-hello.html

 Comments   
Comment by kzeller [ 06/Aug/12 ]
Hi,

Looks like we used myxml and not <programlisting language="csharp">

for the markup.
Comment by kzeller [ 06/Aug/12 ]
Should be fixed with <programlisting language="csharp">




[NCBC-35] Need information on logging in the documentation Created: 06/Apr/12  Updated: 01/Jun/12  Resolved: 01/Jun/12

Status: Closed
Project: Couchbase .NET client library
Component/s: None
Affects Version/s: None
Fix Version/s: 1.1

Type: Improvement Priority: Major
Reporter: MC Brown (Inactive) Assignee: John Zablocki (Inactive)
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   
Currently there's no information on how to create a log of what is going on within .NET apps.

 Comments   
Comment by John Zablocki (Inactive) [ 01/Jun/12 ]
http://www.couchbase.com/docs/couchbase-sdk-net-1.1/couchbase-sdk-net-logging.html
Comment by John Zablocki (Inactive) [ 01/Jun/12 ]
Docs live @ http://www.couchbase.com/docs/couchbase-sdk-net-1.1/couchbase-sdk-net-logging.html




[NCBC-24] Docs for how to enable logging, monitoring, etc. Created: 09/Feb/12  Updated: 05/Oct/12  Resolved: 05/Oct/12

Status: Resolved
Project: Couchbase .NET client library
Component/s: docs
Affects Version/s: 1.0
Fix Version/s: 1.1

Type: Task Priority: Major
Reporter: Tim Smith (Inactive) Assignee: John Zablocki (Inactive)
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified
Environment: Docs, e.g. Google search for [log site:www.couchbase.com/docs/couchbase-sdk-net-1.0/] shows nothing relevant to logging.


 Description   
The Enyim wiki documents how to enable logging and some other things. I'm not sure if these are supported in the same way in the Couchbase Client Library or not. I didn't find any mention of logging in the current Couchbase client docs.

These pages have most of the info I think is missing from our Couchbase Library docs:

https://github.com/enyim/EnyimMemcached/wiki/Configure-Logging

https://github.com/enyim/EnyimMemcached/wiki/Configure-the-Performance-Monitor

https://github.com/enyim/EnyimMemcached/wiki/MembaseClient-Configuration

The last one talks about IMembaseClientConfiguration, etc. Telling users how to customize and subclass the client library interfaces is important.

Regards,

Tim


 Comments   
Comment by Tim Smith (Inactive) [ 15/Feb/12 ]
See also NCBC-12.
Comment by Matt Ingenthron [ 17/Feb/12 ]
Is this closeable now?
Comment by John Zablocki (Inactive) [ 05/Oct/12 ]
This is an appendix now - http://www.couchbase.com/docs/couchbase-sdk-net-1.1/couchbase-sdk-net-logging.html.
Comment by John Zablocki (Inactive) [ 05/Oct/12 ]
http://www.couchbase.com/docs/couchbase-sdk-net-1.1/couchbase-sdk-net-logging.html




[NCBC-9] docs do not describe how to configure dev or production views Created: 29/Sep/11  Updated: 23/Mar/12  Resolved: 23/Mar/12

Status: Resolved
Project: Couchbase .NET client library
Component/s: docs
Affects Version/s: None
Fix Version/s: 1.1

Type: Bug Priority: Critical
Reporter: Matt Ingenthron Assignee: John Zablocki (Inactive)
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Comments   
Comment by John Zablocki (Inactive) [ 23/Mar/12 ]
It is now described at http://www.couchbase.com/develop/net/next
Comment by John Zablocki (Inactive) [ 23/Mar/12 ]
See ProductionModeNameTransformer and DevelopmentModeNameTransformer in Getting Started.




Generated at Sat Aug 30 06:52:19 CDT 2014 using JIRA 5.2.4#845-sha1:c9f4cc41abe72fb236945343a1f485c2c844dac9.