(DOCSP-39082): Updates local deploy with unified docker image. #368

corryroot · 2024-05-07T14:20:55Z

I updated the following page for the unified Docker image updates.

Self-Review Checklist

Check that the submodule pulled in the right changes (if applicable).
Define taxonomy values at top of page.
Add genre facets (tutorial or reference), as in this example PR.
Add programmingLanguage (if necessary).
Add meta keywords (if necessary).
Resolve any new warnings or errors in the build.
Proofread for spelling and grammatical errors.
Check staging for rendering issues.
Confirm links are working.

fmenezes · 2024-05-07T14:24:29Z

source/atlas-cli-deploy-docker.txt

-   .. step:: Pull down the latest ``mongodb/atlas`` Docker image.
-
-      **Example:**
+   .. step:: Pull down the latest ``mongodb/mongodb-atlas-local`` Docker image.


the text Use the atlas deployments command to create a local deployment with Docker. is no longer relevant, we don't need atlas deployments anymore

@fmenezes, I commented in the Google Doc. Is the command good as is for the latest, or should they use docker pull mongodb/mongodb-atlas-local:latest?

:latest is optional for any docker image, but we do offer MongoDB versions like docker pull mongodb/mongodb-atlas-local:7.0.4 and also docker pull mongodb/mongodb-atlas-local:7.0 or docker pull mongodb/mongodb-atlas-local:latest

fmenezes · 2024-05-07T14:27:30Z

source/atlas-cli-deploy-docker.txt

+.. procedure::
+   :style: normal
+
+   .. step:: Install cosign.


we are missing steps here, we need to use the tool

fmenezes · 2024-05-07T14:27:51Z

source/atlas-cli-deploy-docker.txt

+      To learn more, see the :github:`syft README 
+      </anchore/syft/blob/main/README.md>`.
+
+.. step:: Run syft.


on staging I only see step 1, is it missing spaces?

fmenezes · 2024-05-07T14:28:51Z

source/atlas-cli-deploy-docker.txt

+            curl --output mongosh.deb https://downloads.mongodb.com/compass/mongodb-mongosh_2.2.1_amd64.deb
+            sudo dpkg -i mongosh.deb
+            mongosh --version
+        - run: mongosh 'mongodb://localhost/?directConnection=true' --eval 'show dbs'

 Supported Actions


I don't think Supported Actions applies anymore

JuliaMongo

Left a few comments and will look again.

JuliaMongo · 2024-05-07T14:39:53Z

source/atlas-cli-deploy-docker.txt

-      To learn more about the available options, see 
-      :ref:`atlas-deployments-setup`.


Why would it be better to remove "to learn more"?

@JuliaMongo, no longer applies with the unified image.

JuliaMongo · 2024-05-07T14:42:28Z

source/atlas-cli-deploy-docker.txt

+Generate a List of Dependencies
+-------------------------------
+
+You can generate a list of the dependances for the 


dependencies

JuliaMongo · 2024-05-07T14:43:40Z

source/atlas-cli-deploy-docker.txt

+      To learn more, see the :github:`syft README 
+      </anchore/syft/blob/main/README.md>`.


I would move these two lines to be directly after line 281 about the intro to the procedure.

@JuliaMongo, I prefer it here. If they can use brew, they can ignore.

JuliaMongo · 2024-05-07T14:45:18Z

source/atlas-cli-deploy-docker.txt

+      To learn more, see the `cosign Installation 
+      <https://docs.sigstore.dev/system_config/installation/>`__


Same here: it is strange to see this after the fact. Instead, I would do this:
You can verify the signature .... using Cosign. To learn more, see ... link to Cosign.

A suggestion: should we move these long http links to the snooty.toml and use shorter replacements in text?

@JuliaMongo, see above. If they can use brew, they can ignore. If we have multiple cosign links, maybe. For now, I think this is fine as is.

fmenezes · 2024-05-07T15:02:59Z

source/atlas-cli-deploy-docker.txt

+
+            .. code-block:: sh
+
+               mongosh "mongodb://user:pass@localhost:27017/?directConnection=true"

 Create a Local Atlas Deployment with Docker Compose


I think we should remove the Use the atlas deployments command to create a local part

fmenezes · 2024-05-07T15:04:13Z

source/atlas-cli-deploy-docker.txt

+
+   .. step:: Run the following commands.
+
+      **Example::**


Suggested change

**Example::**

**Example:**

JuliaMongo · 2024-05-07T15:04:23Z

LGTM with one q:

Do we need to use the word Example in simple steps? If we do, this is a new practice to me and I am not sure the team is aware of it either.
I usually just add commands after steps, or, in some cases, I say: For example, run the command similar to the following".
(This is when the command is too specific, and the users would need to modify it for their needs in any way).

JuliaMongo

LGTM

corryroot · 2024-05-07T15:09:59Z

LGTM with one q:

Do we need to use the word Example in simple steps? If we do, this is a new practice to me and I am not sure the team is aware of it either.
I usually just add commands after steps, or, in some cases, I say: For example, run the command similar to the following".
(This is when the command is too specific, and the users would need to modify it for their needs in any way).

@JuliaMongo, we have used Example: when there's multiple ways to accomplish the step, but we want to provide a single example.

* (DOCSP-39082): Updates local deploy with unified docker image. * (DOCSP-39082): Incorporated Filipe's feedback. * (DOCSP-39083): Small tweaks. * (DOCSP-39082): Fixed typo per Julia. * (DOCSP-39082): Incorporated Filipe's final feedback. * (DOCSP-39082): Incorporated Filipe's final feedback. * (DOCSP-39082): Incorporated Max's feedback.

(DOCSP-39082): Updates local deploy with unified docker image.

f5e19fb

corryroot requested a review from fmenezes May 7, 2024 14:20

corryroot assigned fmenezes May 7, 2024

fmenezes reviewed May 7, 2024

View reviewed changes

(DOCSP-39082): Incorporated Filipe's feedback.

fbf5cb1

corryroot requested review from fmenezes and JuliaMongo May 7, 2024 14:42

corryroot assigned JuliaMongo May 7, 2024

corryroot added copy review tech review labels May 7, 2024

JuliaMongo reviewed May 7, 2024

View reviewed changes

(DOCSP-39083): Small tweaks.

a07f624

corryroot requested a review from JuliaMongo May 7, 2024 14:56

(DOCSP-39082): Fixed typo per Julia.

ef458a3

corryroot force-pushed the DOCSP-39082 branch from 4aebc4f to ef458a3 Compare May 7, 2024 14:57

fmenezes approved these changes May 7, 2024

View reviewed changes

fmenezes reviewed May 7, 2024

View reviewed changes

(DOCSP-39082): Incorporated Filipe's final feedback.

9c07692

JuliaMongo approved these changes May 7, 2024

View reviewed changes

corryroot unassigned fmenezes and JuliaMongo May 7, 2024

corryroot removed copy review tech review labels May 7, 2024

(DOCSP-39082): Incorporated Filipe's final feedback.

51593e1

corryroot added the RFM label May 7, 2024

(DOCSP-39082): Incorporated Max's feedback.

333d187

corryroot force-pushed the DOCSP-39082 branch from 3d7813d to 333d187 Compare May 13, 2024 12:48

corryroot merged commit c69c660 into mongodb:master May 13, 2024

corryroot deleted the DOCSP-39082 branch May 13, 2024 12:57

corryroot added a commit to corryroot/docs-atlas-cli that referenced this pull request May 13, 2024

(DOCSP-39471): Backport DOCSP-39082 to v1.14. (mongodb#368)

7284a01

corryroot added a commit that referenced this pull request May 13, 2024

(DOCSP-39471): Backport DOCSP-39082 to v1.14. (#368)

1102309

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

(DOCSP-39082): Updates local deploy with unified docker image. #368

(DOCSP-39082): Updates local deploy with unified docker image. #368

corryroot commented May 7, 2024 •

edited

fmenezes May 7, 2024

corryroot May 7, 2024

fmenezes May 7, 2024

fmenezes May 7, 2024

fmenezes May 7, 2024 •

edited

fmenezes May 7, 2024

JuliaMongo left a comment

JuliaMongo May 7, 2024

corryroot May 7, 2024

JuliaMongo May 7, 2024

JuliaMongo May 7, 2024

corryroot May 7, 2024 •

edited

JuliaMongo May 7, 2024

corryroot May 7, 2024 •

edited

fmenezes May 7, 2024

fmenezes May 7, 2024

JuliaMongo commented May 7, 2024 •

edited

JuliaMongo left a comment

corryroot commented May 7, 2024 •

edited

		To learn more about the available options, see
		:ref:`atlas-deployments-setup`.

		To learn more, see the :github:`syft README
		</anchore/syft/blob/main/README.md>`.

		To learn more, see the `cosign Installation
		<https://docs.sigstore.dev/system_config/installation/>`__

(DOCSP-39082): Updates local deploy with unified docker image. #368

(DOCSP-39082): Updates local deploy with unified docker image. #368

Conversation

corryroot commented May 7, 2024 • edited

Self-Review Checklist

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

fmenezes May 7, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JuliaMongo 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

corryroot May 7, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

corryroot May 7, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JuliaMongo commented May 7, 2024 • edited

JuliaMongo left a comment

Choose a reason for hiding this comment

corryroot commented May 7, 2024 • edited

corryroot commented May 7, 2024 •

edited

fmenezes May 7, 2024 •

edited

corryroot May 7, 2024 •

edited

corryroot May 7, 2024 •

edited

JuliaMongo commented May 7, 2024 •

edited

corryroot commented May 7, 2024 •

edited