Updating README.md and wiki

[patty-chow]

See something on our README or wiki that could be improved? Feel free to edit and create a PR!

[YohanSciubukgian]

In the main description there is a highlighting about vCore-Based Azure Cosmos DB for MongoDB « Powering vCore-based Azure Cosmos DB for MongoDB. »

Is CosmosDB for MongoDB (non V-core based) included or excluded from this project ? Why?

As CosmosDB exposes multiple APIs, Could you clarify if CosmosDB for SQL API (historically also named « DocumentDB ») is also part of this project ? If yes, does it means I could run CosmosDB for SQL API on-premise ?

If this repository covers multiple CosmosDB APIs or projects could you explicit them somewhere in the repository?

Thanks 🙏

[shuaitian-git]

@patty-chow please help take a look at above question, thanks!

[YohanSciubukgian]

Could the documentation be enhanced to include a comprehensive features comparison, ideally presented in a table format, between the following:

Engine Comparisons

While the links below are more focused on comparing Azure CosmosDB vs MongoDB Atlas, it would be great to narrow the comparison to just the DocumentDB engine (this project) vs the MongoDB engine:

• MongoDB vs CosmosDB
• Azure CosmosDB vs MongoDB Atlas

1. Microsoft DocumentDB Capabilities

• How does Microsoft DocumentDB compare to MongoDB in terms of features and functionalities?
• Does it offer at least 100% coverage of the MongoDB Community Edition, or are there gaps? If there are gaps, could the documentation detail these specifically?
• Could the additional or extra capabilities provided by DocumentDB, over and beyond what MongoDB offers, be outlined comprehensively?

2. CosmosDB for Mongo DB API

• How does Microsoft DocumentDB compare to CosmosDB for Mongo DB API in terms of features and functionalities?
• Does it offer at least 100% coverage of the CosmosDB for Mongo DB API, or are there gaps? If there are gaps, could the documentation detail these specifically?
• Could the additional or extra capabilities provided by DocumentDB, over and beyond what CosmosDB for Mongo DB API offers, be outlined comprehensively?

3. MongoDB Capabilities

It would be incredibly useful to compare these capabilities against MongoDB documentation references, such as:

• MongoDB CRUD Operations
• Aggregation Operations
• Indexes
• Time Series Collections
• Search & Vector Search capabilities?
• Change Streams
• Transactions
• Data Modeling
• Replication – Including details on PostgreSQL usage and capabilities related to this project.
• Sharding – Again, with a focus on PostgreSQL-specific usage and features for comparison.
• Storage – Highlighting PostgreSQL usage and other details pertinent to this project.
• Security
• Deployment options, such as:
  • Self-Managed Deployments: Compare DocumentDB with OSS alternatives such as FerretDB (relying on your project) .
  • Cloud-based solutions (e.g., Azure CosmosDB) vs. OSS alternatives (FerretDB, others).

---

Benefits of Enhanced Documentation

Adding this information to the documentation would provide several tangible benefits:

• Help users anticipate migration challenges when transitioning from MongoDB to DocumentDB.
• Effectively promote all the capabilities of the current version of DocumentDB.
• Provide a clear roadmap for the community, indicating planned features and improvements.
• Foster discussions and engagement with the community regarding features that could be introduced over time.
• Address the evolution of MongoDB APIs (including Atlas), which frequently add and deprecate functionalities. Will DocumentDB maintain compatibility by following MongoDB's additions and deprecations to ensure high compatibility across versions?