DOCSP-29036: Generate staging link #7
Conversation
There was a problem hiding this comment.
This sentence looks like it has formatting errors:
A :refson_oid_t` that should not be modified or freed.
There was a problem hiding this comment.
The images appear to be broken when viewing this page in staging.
There was a problem hiding this comment.
The toggles in the bottom feel like they are broken and keep kicking back to the Visual Studio page.
There was a problem hiding this comment.
Hm they seem to be working for me. So both the left and right toggles bring you to the visual studio guide?
There was a problem hiding this comment.
The toggle at the bottle had an incorrect link.
There was a problem hiding this comment.
Which one? I'm seeing "Bulk Write Operations" (left) and "Aggregation Framework examples" (right), with both linking to the correct page
There was a problem hiding this comment.
I grouped feedback in one comment since adding comments to files was slow. Here is feedback after skimming the stage links:
https://preview-mongodbnorareidy.gatsbyjs.io/c/DOCSP-29036-staging/libbson/
Replace link to www.mongoc.org? I expect the new reference docs landing page will be at a mongodb.com URL similar.
https://preview-mongodbnorareidy.gatsbyjs.io/c/DOCSP-29036-staging/libbson/api/bson_t/bson_append_oid/
Fix format of :refson_t
https://preview-mongodbnorareidy.gatsbyjs.io/c/DOCSP-29036-staging/libbson/tutorials/include-and-link/
Add :language: c to code sample. Sample code for hello_bson.c does not appear to show syntax highlighting. Compare with https://mongoc.org/libbson/current/include-and-link.html. Same suggestion applies to other ..literal-include code samples.
- Fix formatting of
git-clonenext toDespite the name. - Suggest using inline footnotes to preserve the
XCode [1]andVisual Studio [2]footnote links in the original documentation: https://mongoc.org/libmongoc/1.26.2/learn/get/from-source.html#id5. [C++] Document the Stable ABI Compatibility Policy docs-cpp#7 (comment) shows example use of inline footnotes. - Remove
<cmake--install.--config>.
https://preview-mongodbnorareidy.gatsbyjs.io/c/DOCSP-29036-staging/libmongoc/tutorials/obtaining-libraries/installing/
Remove extra backticks around CMakeLists.txt in code snippet caption.
https://preview-mongodbnorareidy.gatsbyjs.io/c/DOCSP-29036-staging/libmongoc/howto/source-install/
- Remove extra backticks around
pkg-configin code snippet caption. - Remove
<cmake--install.--config>and<cmake.--build>
https://preview-mongodbnorareidy.gatsbyjs.io/c/DOCSP-29036-staging/libmongoc/guides/
Remove Client-Side Field Level Encryption. Client-Side Field Level Encryption is already nested under In-Use Encryption. This results in the page showing twice in the left-hand navigation.
| generated ``IMPORTED`` targets: | ||
|
|
||
| .. code-block:: cmake | ||
| :caption: `CMakeLists.txt` |
There was a problem hiding this comment.
| :caption: `CMakeLists.txt` | |
| :caption: CMakeLists.txt |
| @@ -78,7 +78,7 @@ metadata. | |||
| default, use the following command: | |||
|
|
|||
| .. code-block:: | |||
| :caption: Ask ``pkg-config`` what directories it will search by default | |||
| :caption: Ask `pkg-config` what directories it will search by default | |||
There was a problem hiding this comment.
| :caption: Ask `pkg-config` what directories it will search by default | |
| :caption: Ask pkg-config what directories it will search by default |
There was a problem hiding this comment.
LGTM with backtick removals (commented in files) and this change:
https://preview-mongodbnorareidy.gatsbyjs.io/c/DOCSP-29036-staging/libmongoc/tutorials/obtaining-libraries/from-source/
Remove the <cmake.-G> <cmake.-T> and <cmake.-A> in the footnotes. Those were previously used by Sphinx to link to CMake documentation.
Pull Request Info
Note to reviewer: the individual files have already been reviewed, but this PR is the first to include a fully staged site. As a result, it addresses issues that were missed in previous PRs and surfaced during staging. I'm mainly looking for a review of the staging link to make sure everything looks okay.
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-29036
Staging - https://preview-mongodbnorareidy.gatsbyjs.io/c/DOCSP-29036-staging/
Self-Review Checklist