Skip to content

(DOCS-10465): Include blurb on different MongoDB editions #3331

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

Jump to bottom
Merged
merged 2 commits into from
Jun 14, 2018
Merged

(DOCS-10465): Include blurb on different MongoDB editions #3331

merged 2 commits into from
Jun 14, 2018

Conversation

atsansone
Copy link
Contributor

@atsansone atsansone commented Jun 6, 2018 •
edited
Loading

This change is Reviewable

@atsansone atsansone requested a review from MongoCaleb June 8, 2018 17:28
@atsansone
Copy link
Contributor Author

@MongoCaleb : This is a tricky ticket because we don't declare the differences between Community and Enterprise elsewhere. Maybe the ticket is asking for something unnecessary, but I'd be curious to see if you think this covers the scope of the need and the ticket. Staged.

MongoCaleb
MongoCaleb reviewed Jun 8, 2018
View reviewed changes
Copy link
Contributor

@MongoCaleb MongoCaleb left a comment

Choose a reason for hiding this comment

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

I think the blurb you created answers the ticket; I'm wondering, though, if it doesn't belong at the top installation page (https://docs-mongodbcom-staging.corp.mongodb.com/anthonysansone/DOCS-10465/installation.html), since it's comparing the two types?

So I think I would move the paragraph to the intro of that page, which is currently only a single (short) sentence.

Currently:

This section of the manual contains tutorials on installation of MongoDB.

Proposed:

MongoDB is released as two editions: Community and Enterprise. Community is the open source release of MongoDB. Enterprise provides additional administration, authentication, and monitoring features. *Installation steps vary depending on the edition; both procedures are outlined in this section.*

And perhaps also keep it where you have it, but slightly modified as "these steps are for community; for enterprise, see..." and do the same for the enterprise page.

source/tutorial/install-mongodb-on-windows.txt Outdated
and will automatically upgrade any older version of MongoDB installed
using an ``.msi`` file.
To find which version, service pack, and build of Windows is
running on your host and the processor type of that host, enter the
Copy link
Contributor

Choose a reason for hiding this comment

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

running on your host, as well as the processor type of the host, enter...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Agreed. Fixed.

atsansone
atsansone commented Jun 12, 2018
View reviewed changes
Copy link
Contributor Author

@atsansone atsansone left a comment

Choose a reason for hiding this comment

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

@MongoCaleb ,

Thanks! Made adjustments. Have another look.

T

source/tutorial/install-mongodb-on-windows.txt Outdated
and will automatically upgrade any older version of MongoDB installed
using an ``.msi`` file.
To find which version, service pack, and build of Windows is
running on your host and the processor type of that host, enter the
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Agreed. Fixed.

@atsansone atsansone force-pushed the DOCS-10465 branch 2 times, most recently from ef242ca to 01e5625 Compare June 14, 2018 21:20
@atsansone atsansone assigned kay-kim and unassigned MongoCaleb Jun 14, 2018
@atsansone atsansone added RFM and removed Copy Review labels Jun 14, 2018
@atsansone
Copy link
Contributor Author

@kay-kim : This is RFM for master and v3.6. It is only a clarification between editions. It can stay or go as you see fit.

@kay-kim kay-kim merged commit 6c3ed91 into mongodb:master Jun 14, 2018
mongo-cr-bot pushed a commit that referenced this pull request Jun 22, 2023
@nvillahermosa-mdb @jason-price-mongodb
@jordan-smith721 @mongoKart @jmd-mongo
qe-equality-ga-into-master (#3400)
37aaab1 
* Added upsert limitation (#3252)

* Docsp 28305 qe on disk format wire protocol (#3244)

* Cleaned feature branch

* Internal PR feedback

* Fixed lingering merge text

* External review: removed write amplification for delete operations

* Remove insertmany from QE restricted operations (#3251)

* One line fix

* Removed wording around future release functionality for index compaction. Left key creation language because there's a separate ticket for that content.

* Light editorial cleanup, removed refs to technical preview

* Attempted to clean up wording around unique index limitations

* Attempted to clarify limitation around validation settings

* PR feedback

* Syntax fix

* Updated migration guidance

* Revert "Remove insertmany from QE restricted operations (#3251)" (#3296)

This reverts commit f1377c73483ceed9744d4d48647b56295706dcdc.

* Docsp 29188 remove insertmany from restricted (#3300)

* One line fix

* Removed wording around future release functionality for index compaction. Left key creation language because there's a separate ticket for that content.

* Light editorial cleanup, removed refs to technical preview

* Attempted to clean up wording around unique index limitations

* Attempted to clarify limitation around validation settings

* PR feedback

* Syntax fix

* Docsp 30055 qe public preview ga migration guidance (#3280)

* Updated QE GA constant

* QE constant update, external feedback

* PR feedback

* PR feedback

* PR feedback

* DOCSP-30667 QE Limitations Cleanup (#3331)

* Fixed bulleting for one item, re-ordered and grouped some items for better readability

* Fixed a typo

* Docsp 30646 how qe works cleanup (#3333)

* Removed framework term

* Clarified the inclusion of __safeContent__ applies to queryable fields only

* PR feedback

* Docsp 28249 qe redaction (#3291)

* Rebase to latest state of qe-equality-ga

* Cleaned up old :doc: directives

* Removed self reference links

* Cleaned up old version references

* Spellcheck

* Build cleanup

* Changed collstats redaction per SERVER-75266

* Changed collstats redaction per SERVER-75266--amend

* Moved log redaction to the existing redaction heading

* Moved log redaction to the existing redaction heading--amend

* Moved log redaction to the existing redaction heading--amend

* PR feedback

* Cleanup from qe-equality-ga branch diversion

* PR feedback

* Copy edit, passive voice/future

* Added shortdesc to limitations

* Shortdesc and editorial cleanup

* Rebase cleanup

* Internal review feedback

* External PR feedback

* Docsp 28385 auto encryption keys (#3330)

* Removed manual key creation from limitations

* First look readthrough rebuild

* Reorganization rebuild

* Reviewing current tutorial content

* Self review

* Internal review feedback and merge

* Internal PR feedback

* Rebuild commit

* External review feedback

* DOCSP-30671: libmongocrypt mention and updated driver version
compatibility

* update anchor

* fix wording

* External release notes feedback (#3361)

* updated pymongocrypt version

* updated versions

* Docsp 30670 download links and versions (#3355)

* Rebuild

* Updated shared library version, added second link for downloading

* Internal PR feedback

* csharp version

* Docsp 30840 fix key rotation language (#3387)

* Removed migrate wording

* Internal PR feedback

* Internal PR feedback

* Fle sample app refactor (#3397)

* add java tutorial source only

* maven pom.xml for java build

* update object property passing

* add vm options

* update variables per sync meeting

* Java tutorial naming updates

* c# updates

* c# updates

* fix indents

* update testing instructions

* python - naming updates

* go tutorial - naming updates

* start/end tags and readme

* Go tutorial: added comment labels

* python include tags and readme

* add kms placeholder

* add envrc_template

* update README

* rename project

* start/end tags

* remove extra method

* clean up

* Delete QueryableEncryption.csproj

* Go tutorial: add readme, sample environment template small updates

* remove whitespace

* fix label

* Java tutorial: add labels

* refactored to add auto dek

* c# key auto generation

* refactored tutorial template

* js feedback

* python auto-key

* python replace main script

* python tutorial fix

* java tutorial auto key creation

* create/find first draft

* first draft tutorial text

* typo

* Go tutorial updates for auto key creation

* Python tutorial cleanup

* remove encryptedFieldsMap

* tutorial text feedback

* Add CMK step, fix errors, add Azure tutorial

* admonition for persisting keyId

* keyId admonition edits

* cc feedback

* c# cleanup

* fix compile error

* move return statements

* add project and fix README

* updates to admonition

* PRR fixes to admonition

* cc feedback

* PRR fixes for PyMongo tutorial

* remove insert client from PyMongo tutorial

* apply changes to azure page

* envrc updates for PyMongo tutorial

* apply changes to gcp page

* PRR fix for PyMongo tutorial: check insert result

* apply changes to kmip page

* adds refactored mongosh sample app

* fixes mongosh kmip issue

* Java tutorial dotenv and README updates

* Java README, add dotenv to deps

* update variable names per code review

* code review suggestions

* Golang tutorial updates and various README updates

* fix encrypted fields map

* fix kms

* start adding language tabs

* PRR review fixes for Java tutorial

* add comment in Python tutorial

* PRR fixes for Golang tutorial

* fix for relocated files

* c# edits

* go edits

* java edits

* python edits

* add tabs for all languages

* fix go merge conflict

* fix go merge conflict

* update node variable names per code review

* remove insert client

* update README files

* provide more detail in the README

* adds package.json to mongosh and updates README

* removes package.json

* bd c# feedback

* fix merge error

* README updates for Java and Python, requirements update for Python

* bd c# feedback

* Java and Golang README updates

* envrc fixes

* node readme fix

* updates to READMEs

* fix link to keys and key vaults

* go tutorial fix placeholder

* fix copypasta

* fix driver tab ids

* encryptionCollectionName -> encryptedCollectionName and encryptionDatabaseName -> encryptedDatabaseName

* checks for existing master-key.txt before generating new file

* checks value of acknowledged field on insert results

* updates README

* remove create insert client step

* no need to specify shared lib in mongosh

* clean up

* tutorial fixes

* code fixes for tutorial

* Go fix comment structure

* Python code: update placeholder comments

* mongosh updates

* Bailey feedback and requested changes

* updated code comments to prevent confusion about placeholders

* mongosh - updated code comments to prevent confusion about placeholders

* fix driver tabs for nodejs and java-sync

* small aws fixes

* azure tutorial

* fix language literalinclude references

* azure tutorial

* gcp tutorial

* path updates

* do not install mongosh via homebrew for QE

* fix java paths aws

* tabid fix for java-sync

* tabid fix for nodejs

* Update README.md

* do not install mongosh via homebrew for QE

* tabid and indentation fixes

* direnv install

* remove data

* removes master-key

* removes .envrc

* change insert-patient-document -> insert-document

* snippet fixes

* literalinclude fixes

* fix tabids and include paths

* fix references

* kmip tutorial + code changes

* update go version

* shell placeholder text

* fix includes references

* shell placeholder text azure

* shell placeholder text gcp

* shell placeholder text kmip

* quick start draft

* Java KMIP update

* quick start fixes

* quick start fixes

* kmip include comment fix

* Clarify Java KMIP certificates and TLS options

* fix go code

* update ref tags

* more ref tags + Learn More sections

* rename tutorials and quick start

* fix go code

* fix python comment

* update text

* update import

* Java envrc_template fix

* link to README in Quickstart

* quick-start fixes + automatic encryption wording

* reformat cmk from command line

* automatic encryption wording

* formatting

* formatting

* golang -> go

* Go kmip comment name fix

* refactor branch logic

* add data models to aws tutorial

* java tutorial - updates for quickstart

* fix c# data models

* python tutorial - fix comment boundaries

* add C# data models + fix includes

* python - show kms_provider_credentials

* auto > automatic

* add placeholder

* update java dependencies to latest

* update READMEs to include mention of release candidate

* bd c# feedback

* move c# data models

* update kmsProviders variable

* link to readmes in environment variables admonition

* re-adding deleted method

* java kmip add link

* tutorial fixes

* move start and end comments for kmsProviders

* mongosh fixes

* mongosh kmsProviderCredentials variable

* mongosh updates

* add go models to tutorials and quick start

* go syntax highlight

* spacing

* add shell tab

* bd c# feedback

* kmip fixes

* gcp fix

* go - fix comment boundaries

* remove mongosh

* fix build error

* staging build

* remove duplicates

---------

Co-authored-by: Jordan Smith <[email protected]>
Co-authored-by: Mike Woofter <[email protected]>
Co-authored-by: Mike Woofter <[email protected]>
Co-authored-by: Joseph Dougherty <[email protected]>
Co-authored-by: jmd-mongo <[email protected]>

* Fixing build log errors

---------

Co-authored-by: jason-price-mongodb <[email protected]>
Co-authored-by: Chris Cho <[email protected]>
Co-authored-by: Jordan Smith <[email protected]>
Co-authored-by: Mike Woofter <[email protected]>
Co-authored-by: Mike Woofter <[email protected]>
Co-authored-by: Joseph Dougherty <[email protected]>
Co-authored-by: jmd-mongo <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MongoCaleb MongoCaleb MongoCaleb left review comments

Assignees

@kay-kim kay-kim

Labels
RFM
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@atsansone @MongoCaleb @kay-kim