Include FAQ to README #136
Conversation
|
|
||
| ## What's next? | ||
| We are working towards a Public Preview release early 2025. We do not yet have a timeline for general availability. Exact details of the roadmap will be published soon. Stay tuned! | ||
| What level of support will MongoDB provide to developers using this code? |
There was a problem hiding this comment.
Is this meant to be a new header?
There was a problem hiding this comment.
Yep. Thanks for catching that.
There was a problem hiding this comment.
I think the spirit of these changes could be done more succinctly primarily by expanding the first paragraph of this document. As it stands, the additions feel redundant (for example, stating "not for production use" three times) and poorly structured (compared to what I've done in similar projects). I'll propose an alternative.
|
|
||
| ## Current capabilities | ||
|
|
||
| At this stage, the project should let you replicate the djangoproject.com tutorial with minimal changes. You will likely be able to run it passing a portion of the standard Django test suite but not all of it. Some key features that we have added so far are: |
There was a problem hiding this comment.
This section is too vague to be useful. There are some parts of the list below that will work and some parts that won't. As I have said before, we should document what doesn't work.
| @@ -149,6 +172,10 @@ from the new application's `apps.py` file. | |||
| - You can study the skipped tests in `DatabaseFeatures.django_test_skips` for | |||
| more details on known issues. | |||
|
|
|||
|
|
|||
| ## We value your feedback! | |||
| We invite you to share your feedback as we work to address this challenge. If you are interested in becoming a design partner, please connect with us through our community forum. You can also create issues or submit pull requests directly to our project GitHub repository. | |||
There was a problem hiding this comment.
What does it mean to be a design partner? Where is the community forum?
| @@ -101,6 +101,29 @@ from the new application's `apps.py` file. | |||
| Valid values for `verbosity` are `"queryPlanner"` (default), | |||
| `"executionStats"`, and `"allPlansExecution"`. | |||
|
|
|||
| ## Why are we building a MongoDB-Django integration? | |||
There was a problem hiding this comment.
Putting this background information amid technical details is out of place. I wouldn't personally include this information in this document.
There was a problem hiding this comment.
What about moving it to the top of the document?
|
Superseded by #138. |
No description provided.