[DOCS-7743] Comment on: "manual/core/replica-set-architectures.txt" Created: 25/Apr/16  Updated: 03/Nov/17  Resolved: 09/Aug/16

Status: Closed
Project: Documentation
Component/s: None
Affects Version/s: None
Fix Version/s: 01112017-cleanup

Type: Bug Priority: Major - P3
Reporter: Docs Collector User (Inactive) Assignee: Andrew Aldridge
Resolution: Done Votes: 0
Labels: collector-298ba4e7
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified
Environment:

Location: https://docs.mongodb.org/manual/core/replica-set-architectures/
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64; rv:43.0) Gecko/20100101 Firefox/43.0
Referrer: https://docs.mongodb.org/manual/replication/
Screen Resolution: 1920 x 1200
repo: docs
source: core/replica-set-architectures


Participants:
Days since reply: 7 years, 27 weeks, 1 day ago

 Description   

Hey There,

Just out of interest, I see you use reStructuredText for your documentation. what tool are you using for your doc display on docs.mongodb.org. Is it something in house? I'd like to create something similar for our project.



 Comments   
Comment by Andrew Aldridge [ 09/Aug/16 ]

Hello Dan,

Very sorry that your question[1] fell between the cracks!

Our documentation is built using a two-stage compilation: a tool called giza[1] generates a slew of restructuredText files, which Sphinx[2] then compiles into HTML.

Effectively, giza serves as a template system so that common writing tasks have the same appearance and we can more aggressively single-source similar content.

Unfortunately, this toolchain is a little hard to pull out of the MongoDB documentation build process, and is (ironically) less-than-documented. This is something we want to improve in the future.

Let me know if you have any further questions!

Thanks,
Andrew Aldridge
MongoDB Documentation Team

[1]: https://jira.mongodb.org/browse/DOCS-7743
[2]: https://github.com/mongodb/docs-tools
[3]: http://sphinx-doc.org/

Generated at Thu Feb 08 07:54:54 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.