DOCSP-43368: Cleanup #66

norareidy · 2024-10-01T20:19:15Z

Pull Request Info

JIRA - https://jira.mongodb.org/browse/DOCSP-43368
Staging - https://deploy-preview-66--docs-c.netlify.app/

Self-Review Checklist

Is this free of any warnings or errors in the RST?
Did you run a spell-check?
Did you run a grammar-check?
Are all the links working?
Are the facets and meta keywords accurate?

netlify · 2024-10-01T20:19:30Z

✅ Deploy Preview for docs-c ready!

Name	Link
🔨 Latest commit	`e1de107`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-c/deploys/670ff3a2e9d4cc0008aed473
😎 Deploy Preview	https://deploy-preview-66--docs-c.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

…368-cleanup

mcmorisi

I know @mongoKart is also reviewing but just a couple of callouts.

source/includes/usage-examples/index-code-examples.c

source/includes/usage-examples/sample-indexes-app.c

mongoKart

Good work on some long pages! Seems like a lot of changes, but most are very small. I didn't finish reviewing the last page because I wanted to get something back to you today. Let me know if you have any questions; I tried to explain / link to the SG where it made sense

mongoKart · 2024-10-15T18:56:54Z

source/compatibility.txt

+
+  * - Debian
+    - Versions **9.2**, **10.0**, and **11.0**


Q: Do these versions need to be bold? Applies throughout

mongoKart · 2024-10-15T18:59:18Z

source/compatibility.txt

+  * - RHEL
+    - Versions **7.0**, **7.1**, **8.1**, **8.2**, and **8.3**. RHEL derivatives
+      (e.g. CentOS, Rocky Linux, AlmaLinux) of the same release version are


I: Avoid e.g.

Suggested change

(e.g. CentOS, Rocky Linux, AlmaLinux) of the same release version are

(for example, CentOS, Rocky Linux, or AlmaLinux) of the same release version are

applies throughout

mongoKart · 2024-10-15T19:00:43Z

source/compatibility.txt

+    - Versions **3.7**, **3.8**, and **6.0**. Newer versions
+      are also supported, as well as the corresponding Apple Clang releases.
+  * - GCC


S: probably well enough understood by anyone reading this page, but 🤷‍♂️

Suggested change

* - GCC

* - GNU Compiler Collection (GCC)

mongoKart · 2024-10-15T19:02:24Z

source/compatibility.txt

+  * - x86_64 (64-bit x86)
+    - Tested on Linux, macOS, and Windows
+  * - ARM / aarch64
+    - Tested on macOS and Linux
+  * - Power8 (ppc64le)
+    - Only tested on Linux
+  * - zSeries (s390x)
+    - Only tested on Linux


I: only

Suggested change

- Only tested on Windows

* - x86_64 (64-bit x86)

- Tested on Linux, macOS, and Windows

* - ARM / aarch64

- Tested on macOS and Linux

* - Power8 (ppc64le)

- Only tested on Linux

* - zSeries (s390x)

- Only tested on Linux

- Tested only on Windows

* - x86_64 (64-bit x86)

- Tested on Linux, macOS, and Windows

* - ARM / aarch64

- Tested on macOS and Linux

* - Power8 (ppc64le)

- Tested only on Linux

* - zSeries (s390x)

- Tested only on Linux

mongoKart · 2024-10-15T19:03:18Z

source/compatibility.txt

+~~~~~~~~~~~~~~~~~~~~
+
+Other platforms and toolchains are not tested, but similar versions of the above


I: above

Suggested change

Other platforms and toolchains are not tested, but similar versions of the above

Other platforms and toolchains are not tested, but similar versions of the preceding

mongoKart · 2024-10-15T21:12:19Z

source/install-from-source.txt

+.. note::
+
+   It is *highly recommended* -- but not *required* -- that you download the
+   latest stable CMake available for your platform.


S: remove from note and append to prev. paragraph

Suggested change

.. note::

It is *highly recommended* -- but not *required* -- that you download the

latest stable CMake available for your platform.

We highly recommended that you download the latest stable version of

CMake that is available for your platform.

mongoKart · 2024-10-15T21:13:13Z

source/install-from-source.txt

+.. tip:: Getting the Latest CMake
+
+   A new stable release of CMake can be obtained from
+   `the CMake downloads page <https://cmake.org/download/#latest>`__.
+
+   For Windows and macOS, simply download the CMake ``.msi`` / ``.dmg`` (not the
+   ``.zip`` / ``.tar.gz``) and use it to install CMake.
+
+   On Linux, download the self-extracting shell script (ending with ``.sh``) and
+   execute it using the ``sh`` utility, passing the appropriate arguments to
+   perform the install. For example, with the CMake 3.27.0 on the ``x86_64``
+   platform, the following command can be used on the
+   ``cmake-3.27.0-linux-x86_64.sh`` script:
+
+   .. code-block:: none
+
+      $ sh cmake-3.27.0-linux-x86_64.sh --prefix="$HOME/.local" --exclude-subdir --skip-license
+
+   Assuming that ``$HOME/.local/bin`` is on your ``$PATH`` list, the ``cmake`` command
+   for 3.27.0 will then become available.
+
+   The ``--help`` option can be passed to the shell script for more information.


S: remove from tip box; seems like a pretty important step to install it

mongoKart · 2024-10-15T21:14:18Z

source/install-from-source.txt

+   A new stable release of CMake can be obtained from
+   `the CMake downloads page <https://cmake.org/download/#latest>`__.
+
+   For Windows and macOS, simply download the CMake ``.msi`` / ``.dmg`` (not the


How about different tabs for the OSes, similar to what you did before?

mongoKart · 2024-10-15T21:15:02Z

source/install-from-source.txt

+   A new stable release of CMake can be obtained from
+   `the CMake downloads page <https://cmake.org/download/#latest>`__.
+
+   For Windows and macOS, simply download the CMake ``.msi`` / ``.dmg`` (not the


I: slashes

Suggested change

For Windows and macOS, simply download the CMake ``.msi`` / ``.dmg`` (not the

For Windows and macOS, simply download the CMake ``.msi`` or ``.dmg`` (not the

(using tabs would also solve this issue)

mongoKart · 2024-10-15T21:16:29Z

source/install-from-source.txt

+
+   The ``--help`` option can be passed to the shell script for more information.
+
+For the remainder of this page, it will be assumed that ``cmake`` is available as


I: I'm not as anti-passive-voice as the style guide, but it seems easy to avoid here

Suggested change

For the remainder of this page, it will be assumed that ``cmake`` is available as

This page assumes that ``cmake`` is available as

mongoKart

LGTM w/ a couple small changes

mongoKart · 2024-10-16T16:38:37Z

source/compatibility.txt

-  * - GCC
-    - Versions **4.8**, **5.4**, **6.3**, **7.5**, **8.2**, **8.3**,
-      **9.4**, and **10.2**. The MinGW-w64 GCC is also tested and supported.
+  * - Gnu Compiler Collection (GCC)


Suggested change

* - Gnu Compiler Collection (GCC)

* - GNU Compiler Collection (GCC)

mongoKart · 2024-10-16T16:39:37Z

source/install-from-source.txt

   that are not required to complete the tutorial, but may be helpful for curious
-   readers, and more advanced users that want an explanation of the meaning of
+   readersx and more advanced users that want an explanation of the meaning of


VIM? 😠

Suggested change

readersx and more advanced users that want an explanation of the meaning of

readers and more advanced users that want an explanation of the meaning of

DOCSP-43368: Cleanup

bd37f7e

norareidy added 8 commits October 1, 2024 16:51

edits, add platform compat

1e7fd72

Merge remote-tracking branch 'upstream/standardization' into DOCSP-43…

d584b47

…368-cleanup

Merge remote-tracking branch 'upstream/standardization' into DOCSP-43…

eab9d1a

…368-cleanup

Merge remote-tracking branch 'upstream/standardization' into DOCSP-43…

624d8ee

…368-cleanup

build log fixes

6a1c38b

code highlight

123a18e

toc fix

ee3eb81

run command

6bac982

mcmorisi reviewed Oct 15, 2024

View reviewed changes

source/includes/usage-examples/index-code-examples.c Show resolved Hide resolved

source/includes/usage-examples/sample-indexes-app.c Show resolved Hide resolved

MM feedback

3d609d5

mongoKart requested changes Oct 15, 2024

View reviewed changes

norareidy added 2 commits October 16, 2024 11:00

MW feedback

b7dd96a

edits

0b1714a

norareidy requested a review from mongoKart October 16, 2024 15:12

mongoKart approved these changes Oct 16, 2024

View reviewed changes

norareidy added 2 commits October 16, 2024 13:09

MW feedback 2

4ad54cd

landing page

e1de107

norareidy merged commit 74dab6c into mongodb:standardization Oct 16, 2024
4 of 5 checks passed

norareidy deleted the DOCSP-43368-cleanup branch October 16, 2024 17:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOCSP-43368: Cleanup #66

DOCSP-43368: Cleanup #66

norareidy commented Oct 1, 2024 •

edited

Loading

netlify bot commented Oct 1, 2024 •

edited

Loading

mcmorisi left a comment

mongoKart left a comment

mongoKart Oct 15, 2024

mongoKart Oct 15, 2024

mongoKart Oct 15, 2024

mongoKart Oct 15, 2024

mongoKart Oct 15, 2024

mongoKart Oct 15, 2024

mongoKart Oct 15, 2024

mongoKart Oct 15, 2024

mongoKart Oct 15, 2024

mongoKart Oct 15, 2024

mongoKart left a comment

mongoKart Oct 16, 2024

mongoKart Oct 16, 2024

norareidy Oct 16, 2024

	(e.g. CentOS, Rocky Linux, AlmaLinux) of the same release version are
	(for example, CentOS, Rocky Linux, or AlmaLinux) of the same release version are

		~~~~~~~~~~~~~~~~~~~~

		Other platforms and toolchains are not tested, but similar versions of the above

	For Windows and macOS, simply download the CMake ``.msi`` / ``.dmg`` (not the
	For Windows and macOS, simply download the CMake ``.msi`` or ``.dmg`` (not the


		The ``--help`` option can be passed to the shell script for more information.

		For the remainder of this page, it will be assumed that ``cmake`` is available as

	For the remainder of this page, it will be assumed that ``cmake`` is available as
	This page assumes that ``cmake`` is available as

	* - Gnu Compiler Collection (GCC)
	* - GNU Compiler Collection (GCC)

	readersx and more advanced users that want an explanation of the meaning of
	readers and more advanced users that want an explanation of the meaning of

DOCSP-43368: Cleanup #66

DOCSP-43368: Cleanup #66

Conversation

norareidy commented Oct 1, 2024 • edited Loading

Pull Request Info

Self-Review Checklist

netlify bot commented Oct 1, 2024 • edited Loading

✅ Deploy Preview for docs-c ready!

mcmorisi left a comment

Choose a reason for hiding this comment

mongoKart left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mongoKart left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

norareidy commented Oct 1, 2024 •

edited

Loading

netlify bot commented Oct 1, 2024 •

edited

Loading