-
Notifications
You must be signed in to change notification settings - Fork 244
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DRIVERS-2789 Convert Unified Test Spec to Markdown #1503
Conversation
I had to remove a dead link to https://emptysqua.re/blog/mongodb-testing-network-errors/. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Couple of suggestions but nothing I'd need to follow up on.
|
||
## Changelog | ||
|
||
- 2024-02-06: Migrated from reStructuredText to Markdown. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I overlooked this in previous PRs but there's no way we can retain Definition Lists here, since it's non-standard syntax, correct?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Correct, it doesn't render:
First Term
: This is the definition of the first term.
Second Term
: This is one definition of the second term.
: This is another definition of the second term.
Allow named KMS providers in `kmsProviders`. Note location of Client-Side | ||
Encryption test credentials. | ||
|
||
- 2024-01-03: Document server version requirements for `errorLabels` and\ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
https://spec.commonmark.org/0.29/#example-631 suggests the trailing slash is used for a hard line break. I can see doing that for the "Schema version" highlights (although the bold text should already make them stand out), but why here and other entries with non-formatted text?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure why pandoc chose to do that
@ajdavis: FYI, that article still comes up on your blog's search widget, but there's no icon for it and the page is a 404. |
I rm'ed it in 60a3ab4, but mongodb/specifications#1503 needs it
Oops, I restored that article to my site now. I (wrongly?) thought it was obsolete and deleted it a while ago. |
Co-authored-by: Jeremy Mikola <[email protected]>
…RS-2789-unified-test
@blink1073: I just realized that various internal link targets in the converted Unified Test Format spec were changed to |
The original doc had |
I'm unsubscribing, if you need me for anything LMK. |
This seems related to original RST links to internal page anchors.
...was changed to:
Assuming this wasn't the only spec affected, can you check for this in any outstanding PRs? For things that were already merged, I suppose it can be handled in a follow-up ticket within the epic. The broken links should definitely not remain as-is. |
Please complete the following before merging:
clusters, and serverless).