Skip to content

DOCS-3711#1938

Closed
mpaik wants to merge 4 commits into
mongodb:masterfrom
mpaik:DOCS-3711
Closed

DOCS-3711#1938
mpaik wants to merge 4 commits into
mongodb:masterfrom
mpaik:DOCS-3711

Conversation

@mpaik

@mpaik mpaik commented Aug 21, 2014

Copy link
Copy Markdown
Contributor

Clarify different procedure for adding first user admin or root user

Comment thread source/includes/access-create-user.rst Outdated

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I'm wary of relative references (e.g. step 3) to other parts of content, particularly in includes files. This file is used six different files.

Also I'm not sure that this needs to be inside of a note block. It's not more special than the other items discussed in the file.

You can check for include-file use with the following operation:

$ giza includes graph -f /includes/access-create-user.rst 
{
    "/includes/access-create-user.rst": [
       "/reference/command/createUser.txt", 
       "/reference/method/db.createUser.txt", 
       "/tutorial/add-admin-user.txt", 
       "/tutorial/add-user-administrator.txt", 
       "/tutorial/add-user-to-database.txt"
     ]
 }

@tychoish

Copy link
Copy Markdown
Contributor

I think it probably makes sense to either put this directly in the tutorial source file or to make a separate include file to include beneath a new heading on the three relevant tutorials.

@mpaik

mpaik commented Aug 21, 2014

Copy link
Copy Markdown
Contributor Author

Already done, building now to check syntax. It's staying in a note box because it's a gotcha - the information was already inline in the text and was missed by the ticket filer. Re: 'note', your wariness is duly noted (hah!). Unless you want me to nest note boxes, it's staying as it is a gotcha within a gotcha. This may change as we improve the docs milieu around user management, but that's out of scope for a ticket of this size and severity.

@mpaik mpaik closed this Aug 21, 2014
@tychoish

Copy link
Copy Markdown
Contributor

I think it would be more effective and easier to catch if you dropped the note and italicize or bold the section.

(Our movement away from note boxes comes from aje and above.)

@mpaik mpaik reopened this Aug 22, 2014
@tychoish

Copy link
Copy Markdown
Contributor

merged

@tychoish tychoish closed this Aug 25, 2014
mongodb-server-docs-sync-bot Bot pushed a commit that referenced this pull request Jun 26, 2025
* DOCSP-44124-ToC-Refactor

* DOCSP-44124-ToC-Refactor

* DOCSP-44124-ToC-Refactor

* DOCSP-44124-ToC-Refactor

* DOCSP-44124-ToC-Refactor

* DOCSP-44124 copy edits

* DOCSP-44124 adding ampersand

(cherry picked from commit fb446a6)
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