Skip to content

DOCSP-42971-vscode-nested-components #93

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 5 commits into from
Sep 16, 2024
Merged

DOCSP-42971-vscode-nested-components #93

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d88fb3a
DOCSP-42971-vscode-nested-components
gmiller-mdb Sep 13, 2024
20574d8
took out extranous line
gmiller-mdb Sep 13, 2024
43dc962
build errors
gmiller-mdb Sep 16, 2024
6fa8932
more build errors
gmiller-mdb Sep 16, 2024
0a2ccd2
be
gmiller-mdb Sep 16, 2024
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
8 changes: 3 additions & 5 deletions source/commands.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _vsce-commands:

=====================
|vsce-short| Commands
|vscode-short| Commands
=====================
Copy link
Collaborator

Choose a reason for hiding this comment

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

[nit] since we changed the variable here, we want to make sure the header syntax has enough =s to cover the text. a new build error is popping up bc of this!


.. default-domain:: mongodb
Expand Down Expand Up @@ -76,10 +76,8 @@ To learn more about connecting to a deployment, see :ref:`vsce-connect`.
- Select and remove a connection from your list of connections
in |vsce|.

.. note::

Removing your current active connection also closes that
connection.
Removing your current active connection also closes that
connection.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I can't comment on the applicable lines, but on this file and on settings.txt, build errors are being caused by the |vsce-short| substitution. Can you check to make sure this variable exists in snooty.toml? If not, replace the variable with |vsce| !

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@ajhuh-mdb Tried to fix the build errors seems like the new command is 'vscode-short'. Hopefully that works!

Shell Commands
--------------
Expand Down
22 changes: 10 additions & 12 deletions source/includes/admonitions/warn-configure-path.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,17 @@
.. important::

To launch your selected MongoDB shell, you must:
To launch your selected MongoDB shell, you must:
Copy link
Collaborator

Choose a reason for hiding this comment

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

[nit] since we removed the important:: admonition, we want to make sure the the text here has no indentations & is flushed to the margin of the page!

Suggested change
To launch your selected MongoDB shell, you must:
To launch your selected MongoDB shell, you must:


- Install the shell you want to use, and
- Install the shell you want to use, and

- Configure your machine's ``PATH`` environment variable to include
the filepath to your shell binary.
- Configure your machine's ``PATH`` environment variable to include
the filepath to your shell binary.

If you install a new version of your MongoDB shell, you will need to
update your ``PATH`` variable to reference the new version.
If you install a new version of your MongoDB shell, you will need to

Check failure on line 9 in source/includes/admonitions/warn-configure-path.rst

View workflow job for this annotation

GitHub Actions / TDBX Vale rules 

[vale] reported by reviewdog 🐶
[MongoDB.ConciseTerms] 'must' is preferred over 'will need to'.

Raw Output:
{"message": "[MongoDB.ConciseTerms] 'must' is preferred over 'will need to'.", "location": {"path": "source/includes/admonitions/warn-configure-path.rst", "range": {"start": {"line": 9, "column": 59}}}, "severity": "ERROR"}
update your ``PATH`` variable to reference the new version.

.. seealso::

- To install the legacy :binary:`mongo <mongo>`
shell, see :manual:`The mongo Shell </mongo>`.
- To install the legacy :binary:`mongo <mongo>`
shell, see :manual:`The mongo Shell </mongo>`.

- To install the ``mongosh`` shell and for instructions on
configuring your ``PATH`` variable, see :mongosh:`Install the MongoDB Shell </install>`.
- To install the ``mongosh`` shell and for instructions on
configuring your ``PATH`` variable, see :mongosh:`Install the MongoDB Shell </install>`.
28 changes: 12 additions & 16 deletions source/includes/steps-starting-vsce-connect-with-advanced-connection-settings.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,33 +157,30 @@ content: |
specify the :guilabel:`Hostname`. You do not need to
specify a port.

.. note::

You can only use SRV connection strings to connect to
deployments running MongoDB 3.6 and later.


SRV connection strings have a prefix of
``mongodb+srv:``. If you are using an SRV connection
string, you do not need to include ``mongodb+srv`` in
your :guilabel:`Hostname`.

.. example::
For example:

If the following is your SRV connection string for
Copy link
Collaborator

Choose a reason for hiding this comment

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

I believe the indents here are also causing build errors!

your MongoDB deployment:

.. code-block:: shell
:copyable: false
:copyable: false

mongodb+srv://<username>:<password>@gettingstarted-7q2cs.mongodb.net/test
mongodb+srv://<username>:<password>@gettingstarted-7q2cs.mongodb.net/test

Then, in |vsce|, you would specify your
:guilabel:`Hostname` as:

.. code-block:: shell
:copyable: false
:copyable: false

gettingstarted-7q2cs.mongodb.net
gettingstarted-7q2cs.mongodb.net

* - :guilabel:`Authentication`
- Authentication to use if the deployment requires
Expand Down Expand Up @@ -258,14 +255,13 @@ content: |
provide the :guilabel:`Username` to authenticate
the user.

.. note::

If you are using
:atlas:`Atlas-managed certificates </security-add-mongodb-users/#select-an-authentication-method>`
, your username must be prefaced by "CN="
per `RFC 2253 <https://tools.ietf.org/html/rfc2253>`__.
For example, the username "X509User" must be
provided as "CN=X509User".
If you are using
:atlas:`Atlas-managed certificates </security-add-mongodb-users/#select-an-authentication-method>`
, your username must be prefaced by "CN="
per `RFC 2253 <https://tools.ietf.org/html/rfc2253>`__.
For example, the username "X509User" must be
provided as "CN=X509User".

- id: ldap
name: LDAP
Expand Down
2 changes: 1 addition & 1 deletion source/settings.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _vsce-settings:

=====================
|vsce-short| Settings
|vscode-short| Settings
=====================

.. default-domain:: mongodb
Expand Down
Loading