Skip to content
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.

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

Mongo Express: Update docs of mongo-express #2401

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

berviantoleo
Copy link

@berviantoleo berviantoleo changed the title Update docs of mongo-express Mongo Express: Update docs of mongo-express Dec 20, 2023
Copy link
Member

@tianon tianon left a comment

Choose a reason for hiding this comment

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

In CI, our markdownfmt I think found a case of tabs vs spaces, and I've left a couple suggestions for using the templating to inject the image name (so it works properly on the architecture-specific repos too)

-e ME_CONFIG_OPTIONS_EDITORTHEME="ambiance" \
-e ME_CONFIG_BASICAUTH_USERNAME="user" \
-e ME_CONFIG_BASICAUTH_PASSWORD="fairly long password" \
mongo-express
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
mongo-express
%%IMAGE%%

@@ -9,7 +9,7 @@ mongo-express is a web-based MongoDB admin interface written in Node.js, Express
# How to use this image

```console
$ docker run --network some-network -e ME_CONFIG_MONGODB_SERVER=some-mongo -p 8081:8081 %%IMAGE%%
$ docker run --link some_mongo_container:mongo -p 8081:8081 -e ME_CONFIG_MONGODB_URL="mongodb://mongo:27017" mongo-express
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
$ docker run --link some_mongo_container:mongo -p 8081:8081 -e ME_CONFIG_MONGODB_URL="mongodb://mongo:27017" mongo-express
$ docker run --link some_mongo_container:mongo -p 8081:8081 -e ME_CONFIG_MONGODB_URL="mongodb://mongo:27017" %%IMAGE%%

Copy link
Member

Choose a reason for hiding this comment

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

Also, --link is deprecated and we removed it from most of our docs intentionally; see #1441

-e ME_CONFIG_BASICAUTH_PASSWORD="fairly long password" \
%%IMAGE%%
--name mongo-express \
--link web_db_1:mongo \
Copy link
Member

Choose a reason for hiding this comment

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

👀

@tianon
Copy link
Member

tianon commented Dec 21, 2023

You might also appreciate ./markdownfmt.sh -w mongo-express/content.md (will run markdownfmt in a container and just write the result directly to your local file which you can then commit).

Signed-off-by: Bervianto Leo Pratama <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants