DOCSP-45732-add-proxy-setting-compass-config #716

amalhotra-mdb · 2025-01-27T21:48:49Z

DESCRIPTION

add a new proxy setting to the Compass config file docs.

STAGING

https://deploy-preview-716--docs-compass.netlify.app/settings/config-file/

JIRA

https://jira.mongodb.org/browse/DOCSP-45732

BUILD LOG

Self-Review Checklist

Is this free of any warnings or errors in the RST?
Is this free of spelling errors?
Is this free of grammatical errors?
Is this free of staging / rendering issues?
Are all the links working?

External Review Requirements

What's expected of an external reviewer?

netlify · 2025-01-27T21:49:11Z

✅ Deploy Preview for docs-compass ready!

Name	Link
🔨 Latest commit	`d03a786`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-compass/deploys/679a4f9fa9e8990008b73f5e
😎 Deploy Preview	https://deploy-preview-716--docs-compass.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.

betsybutton · 2025-01-28T15:10:11Z

source/settings/config-file.txt

+       with. For more information on connecting to your deployment with a
+       proxy, see :ref:`ssh-connection`.
+
+       You must pass either a URL or a DevtoolsProxyOptions object as JSON


Users won't know what a DevtoolsProxyOptions object is -- we'll need to explain what this means, or maybe give an example.

thank you for your review, @betsybutton ; changes made, let me know how the approach i took looks to you.

betsybutton · 2025-01-28T15:11:37Z

source/settings/config-file.txt

+       for the Proxy setting. You can also set the Proxy setting to an empty
+       string. 


Can we specify that if proxy is set to an empty string, no proxy will be used?

addaleax · 2025-01-28T17:02:03Z

source/settings/config-file.txt

+       proxy, see :ref:`ssh-connection`.
+
+       You must pass either a URL or a ``DevtoolsProxyOptions`` object as JSON
+       for the Proxy setting. A ``DevtoolsProxyOptions`` object takes the following


There's a mixture of proxy with and without capital P here, might be good to align them (I see no reason why we'd capitalize it)

addaleax · 2025-01-28T17:03:48Z

source/settings/config-file.txt

+            useEnvironmentVariableProxies: boolean;
+            sshOptions: {
+              identityKeyFile: string;
+              identityKeyPassphrase: string;
+            };
+            ca: ConnectionOptions['ca'];
+            env: Record<string, string | undefined>;


Suggested change

useEnvironmentVariableProxies: boolean;

sshOptions: {

identityKeyFile: string;

identityKeyPassphrase: string;

};

ca: ConnectionOptions['ca'];

env: Record<string, string | undefined>;

I wouldn't expose any of these options to users, they're meant to be internal. proxy and noProxyHosts are the relevant options here.

thank you for taking a look at this @addaleax, could you take a second look at the changes, when you get a chance?

addaleax · 2025-01-28T17:36:29Z

source/settings/config-file.txt

+       with. For more information on connecting to your deployment with a
+       proxy, see :ref:`ssh-connection`.
+
+       You must pass either a URL or a ``DevtoolsProxyOptions`` object as JSON


I'd still avoid using DevtoolsProxyOptions here if we can. It's not a meaningful term for users.

thanks @addaleax ! just to clarify, do you think we should take out the references to DevtoolsProxyOptions and the JSON block showing the format for the object, or just take out the references to DevtoolsProxyOptions but keep the code block?

It's just the name that's meaningless, the JS block (it's JS here, not JSON, although the users will need to use JSON – maybe also worth adjusting) defines what the structure is so there's no need to define a name that's never used again

Agreed - it would be better to have the example represent the actual structure the value needs to take.

betsybutton · 2025-01-28T19:51:48Z

source/settings/config-file.txt

+     - Allows you to enforce or define a proxy to connect to your deployment 
+       with. For more information on connecting to your deployment with a


Super nit pick, but ending a sentence with "with" sounds a bit informal. Should we reword this to:

Enables you to specify or enforce the use of a proxy for connecting to your deployment.

thanks @betsybutton ! could you take a final look at this to see if the changes look ok to you?

ltran-mdb2

Thanks @amalhotra-mdb ! I just left a couple suggestions!

ltran-mdb2 · 2025-01-28T21:21:12Z

source/settings/config-file.txt

+     - Enables you to specify or enforce the use of a proxy for connecting 
+       to your deployment. For more information on connecting to your 


[suggestion] to avoid using a gerund

Suggested change

- Enables you to specify or enforce the use of a proxy for connecting

to your deployment. For more information on connecting to your

- Enables you to specify or enforce the use of a proxy to connect

to your deployment. For more information on connecting to your

ltran-mdb2 · 2025-01-28T21:21:48Z

source/settings/config-file.txt

+       You must pass either a URL or pass the following format: 
+


[suggestion] for minimalism

Suggested change

You must pass either a URL or pass the following format:

You must pass either a URL or the following format:

ltran-mdb2 · 2025-01-28T21:22:25Z

source/settings/config-file.txt

+       If you set ``proxy`` to an empty string, no 
+       proxy will be used.


[suggestion] for active voice

Suggested change

If you set ``proxy`` to an empty string, no

proxy will be used.

If you set ``proxy`` to an empty string, your deployment does not use a proxy.

If you want this, it should be

Suggested change

If you set ``proxy`` to an empty string, no

proxy will be used.

If you set ``proxy`` to an empty string, Compass does not use a proxy.

amalhotra-mdb · 2025-01-29T16:00:42Z

Thanks for your review, @ltran-mdb2 ! Could you take another look at this, whenever you get a chance? Thank you!

ltran-mdb2

LGTM! Thanks @amalhotra-mdb !

betsybutton

LGTM, thank you Anika!

DOCSP-45732-add-proxy-setting-compass-config

2506b12

amalhotra-mdb added 2 commits January 27, 2025 16:53

capitalization

ee3e020

wording

d2cf6d7

betsybutton reviewed Jan 28, 2025

View reviewed changes

amalhotra-mdb added 2 commits January 28, 2025 10:29

reviewer changes

5c54986

update code ex

377ec6d

amalhotra-mdb requested a review from betsybutton January 28, 2025 16:23

addaleax reviewed Jan 28, 2025

View reviewed changes

amalhotra-mdb added 2 commits January 28, 2025 12:15

reviewer changes

5414ec4

standardize monospace

80318ec

amalhotra-mdb requested a review from addaleax January 28, 2025 17:29

addaleax approved these changes Jan 28, 2025

View reviewed changes

addaleax reviewed Jan 28, 2025

View reviewed changes

remove ref to irrelevant data type name

76af349

betsybutton reviewed Jan 28, 2025

View reviewed changes

amalhotra-mdb added 2 commits January 28, 2025 15:04

reviewer changes

1a4047c

change code format

d17952b

amalhotra-mdb requested a review from betsybutton January 28, 2025 20:14

ltran-mdb2 reviewed Jan 28, 2025

View reviewed changes

reviewer changes

d03a786

amalhotra-mdb requested a review from ltran-mdb2 January 29, 2025 16:00

ltran-mdb2 reviewed Jan 29, 2025

View reviewed changes

betsybutton approved these changes Jan 31, 2025

View reviewed changes

jeff-allen-mongo merged commit 7710cb9 into mongodb:master Jan 31, 2025
5 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOCSP-45732-add-proxy-setting-compass-config #716

DOCSP-45732-add-proxy-setting-compass-config #716

amalhotra-mdb commented Jan 27, 2025 •

edited

Loading

netlify bot commented Jan 27, 2025 •

edited

Loading

betsybutton Jan 28, 2025

amalhotra-mdb Jan 28, 2025

betsybutton Jan 28, 2025

addaleax Jan 28, 2025

addaleax Jan 28, 2025

amalhotra-mdb Jan 28, 2025

addaleax Jan 28, 2025

amalhotra-mdb Jan 28, 2025

addaleax Jan 28, 2025

betsybutton Jan 28, 2025 •

edited

Loading

betsybutton Jan 28, 2025

amalhotra-mdb Jan 29, 2025

ltran-mdb2 left a comment

ltran-mdb2 Jan 28, 2025

ltran-mdb2 Jan 28, 2025

ltran-mdb2 Jan 28, 2025

addaleax Jan 28, 2025

amalhotra-mdb commented Jan 29, 2025

ltran-mdb2 left a comment

betsybutton left a comment

		for the Proxy setting. You can also set the Proxy setting to an empty
		string.

		- Allows you to enforce or define a proxy to connect to your deployment
		with. For more information on connecting to your deployment with a

		- Enables you to specify or enforce the use of a proxy for connecting
		to your deployment. For more information on connecting to your

	You must pass either a URL or pass the following format:
	You must pass either a URL or the following format:

		If you set ``proxy`` to an empty string, no
		proxy will be used.

DOCSP-45732-add-proxy-setting-compass-config #716

DOCSP-45732-add-proxy-setting-compass-config #716

Conversation

amalhotra-mdb commented Jan 27, 2025 • edited Loading

DESCRIPTION

STAGING

JIRA

BUILD LOG

Self-Review Checklist

External Review Requirements

netlify bot commented Jan 27, 2025 • edited Loading

✅ Deploy Preview for docs-compass ready!

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

betsybutton Jan 28, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ltran-mdb2 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

amalhotra-mdb commented Jan 29, 2025

ltran-mdb2 left a comment

Choose a reason for hiding this comment

betsybutton left a comment

Choose a reason for hiding this comment

amalhotra-mdb commented Jan 27, 2025 •

edited

Loading

netlify bot commented Jan 27, 2025 •

edited

Loading

betsybutton Jan 28, 2025 •

edited

Loading