Skip to content

(DOCS-10466, -10467, -11485): Updated System Requirements for Community Windows install. #3330

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jun 12, 2018
Merged

(DOCS-10466, -10467, -11485): Updated System Requirements for Community Windows install. #3330

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 24 additions & 19 deletions source/tutorial/install-mongodb-on-windows.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,34 +15,39 @@ Overview

Use this tutorial to install MongoDB Community Edition on Windows systems.

.. admonition:: Platform Support

Starting in version 3.6 MongoDB requires Windows Server 2008 R2,
Windows 7, or later.

.. important:: If you are running any edition of Windows Server 2008
R2 or Windows 7, please install `a hotfix to resolve an issue with
memory mapped files on Windows <http://support.microsoft.com/kb/2731284>`_.

.. note::

.. include:: /includes/fact-default-bind-ip-change.rst

Requirements
------------
System Requirements
-------------------

MongoDB Community Edition requires Windows Server 2008 R2, Windows 7, or
later. The ``.msi`` installer includes all other software dependencies
and will automatically upgrade any older version of MongoDB installed
using an ``.msi`` file.
MongoDB Community Edition requires Microsoft Windows Server 2008 R2 or
later or Microsoft Windows 7 or later on an x86 64-bit architecture.
The Windows installer (``.msi``) file includes all other
software dependencies and automatically upgrades any previous version
of MongoDB that was installed using an ``.msi`` file.

To find which version of Windows you are running, enter the following
commands in the :guilabel:`Command Prompt` or :guilabel:`Powershell`:
To find which version, service pack, and build of Windows is
running on your host and the processor type of that host, enter the
following command in either the :guilabel:`Command Prompt` or
:guilabel:`Powershell`:

.. code-block:: powershell

wmic os get caption
wmic os get osarchitecture
PS C:\> systeminfo | findstr /B /C:"OS Name" /C:"OS Version" /C:"System Type"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried this command on Windows 10 Enterprise and got no response. Any reason we can't just point them to the Control Panel -> System and Security? I would think that a user who can't find this information without looking at 3rd party documentation would be more comfortable with the GUI, anyway.

Which brings me to another question: why not point them to Microsoft documentation for this information? Traditionally, tech pubs departments eschew documenting software procedures from a third party.

However, if you decide to stick with the third-party doc and command prompt, I also note that it's hard to distinguish the prompt from the command. Do we have the ability to use color for the prompt?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I verified that this command works in Command Line and Powershell with @jdestefano-mongo , @steveren and @markbenvenuto . Normally, I would agree about referencing Microsoft docs, but they don't document this clearly anywhere. This was found on a Windows Blog. Agreed on the formatting, but we don't have differing styles / roles / classes for these. I wish we did.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think my trial copy of Windows 10 Enterprise is disabled now that it is expired, which probably explains why my attempt failed.


.. code-block:: powershell
:copyable: false

OS Name: Microsoft Windows 10 Pro
OS Version: 10.0.17134 N/A Build 17134
System Type: x64-based PC

.. important:: If you are running any edition of Windows Server 2008
R2 or Windows 7, please install `a hotfix to resolve an issue with
memory mapped files on Windows
<http://support.microsoft.com/kb/2731284>`_.

Get MongoDB Community Edition
-----------------------------
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another tech writing guideline: don't immediately follow a heading with another heading. Can we add an introductory sentence between Install MongoDB Community Edition and Interactive Installation?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This whole page is getting refactored. I'm okay with leaving this until I do the full refactor after all of the remaining tickets are sorted.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will clean this up when I go through everything on the last ticket.

Expand Down