[CSHARP-2814] Investigate possible SandCastle alternatives Created: 21/Oct/19  Updated: 12/Sep/23  Resolved: 12/Sep/23

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

Type: Task Priority: Major - P3
Reporter: Vincent Kam (Inactive) Assignee: Unassigned
Resolution: Duplicate Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Duplicate
duplicates CSHARP-4783 API docs generating with docfx Closed
Documentation Changes Summary:

1. What would you like to communicate to the user about this feature?
2. Would you like the user to see examples of the syntax and/or executable code and its output?
3. Which versions of the driver/connector does this apply to?


 Description   

Sandcastle is getting a little long in the tooth: "Sandcastle was originally created by Microsoft back in 2006. The last official release from Microsoft occurred in June 2010. Until October 2012, it was hosted at the Sandcastle project site on CodePlex. In October 2012, Microsoft officially declared that they were ceasing support and development of Sandcastle."  

DocFx seems to be Microsoft's successor to SandCastle. There are other options as well.

 
Devil's advocate counterpoints:
The GitHub project supporting SandCastle is still reasonable active though.



 Comments   
Comment by Vincent Kam (Inactive) [ 03/Jan/20 ]

Bumping this back to needs triage to discuss at our triage meeting

Comment by Esha Bhargava [ 02/Jan/20 ]

vincent.kam If the issue is no longer reproducible, I don't think filing a bug makes sense at this time. I'll defer it to you guys though.

Comment by Vincent Kam (Inactive) [ 02/Jan/20 ]

esha.bhargava From the brief investigation done circa Dec 9, it appears that the outage we experienced previously may have been a temporary one since I was able to successfully build the API docs without the cache. Given that, do we still want to file a bug?

Comment by Esha Bhargava [ 16/Dec/19 ]

vincent.kam Please report a bug in the Sand Castle github issues to find out what is going on with the MS web service.

Comment by Esha Bhargava [ 28/Oct/19 ]

Scope doc would be helpful for this

Generated at Wed Feb 07 21:43:36 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.