search

django-nonrel / docs

DEPRECATED - See docs in subprojects
http://www.django-nonrel.org/
7 stars 3 forks source link

Recycle Django MongoDB Engine docs #3

Closed jonashaag closed 12 years ago

jonashaag commented 12 years ago

We've got a lot of stuff in the MongoDB Engine docs that should really be located in the djangotoolbox docs (like ListField, embedding models etc).

Copy that over (or rewrite ;-) and delete it from MongoDB Engine, leaving a reference to the new docs.

flaper87 commented 12 years ago

+1 mv from MongoDB Engine to nonrel

dillongreen commented 12 years ago

+1 as the repos will be moved over to the django-nonrel project page anyway

dartdog commented 12 years ago

If someone will get them there I'll fit them in the current doc structure..

jonashaag commented 12 years ago

also this https://gist.github.com/1200165

dillongreen commented 12 years ago

@jonashaag @FlaPer87 @dartdog just to be clear, if say we move djangotoolbox related info from django-mongodb.org to the new docs, would the function of django-mongodb.org be more or less a quickstart/tutorial for how to get started with Django and MongoDB and more detailed info (e.g. about field reference of EmbeddedModelField etc.) be found on https://github.com/django-nonrel/docs (respectively the docs on http://readthedocs.org/docs/django-nonrel/en/latest/index.html)? Is that the idea yes?

Or is there a plan to get rid of contents on django-mongodb.org at some point and have it point to http://readthedocs.org/docs/django-nonrel/en/latest/index.html for said quickstart/tutorial as well?

jonashaag commented 12 years ago

Yes the idea was to keep django-mongodb.org as a quickstart page and as documentation for MongoDB specific stuff (Django ORM API "extensions", what to keep in mind when developing with MongoDB, MongoDB-specific troubleshooting etc).

Not sure what to do with the tutorial.

flaper87 commented 12 years ago

I would move the tutorial too. It's not django-mongodb specific, at least it shouldn't be.

On Saturday 28 de January de 2012 at 19:05, Jonas Haag wrote:

Yes the idea was to keep django-mongodb.org (http://django-mongodb.org) as a quickstart page and as documentation for MongoDB specific stuff (Django ORM API "extensions", what to keep in mind when developing with MongoDB, MongoDB-specific troubleshooting etc).

Not sure what to do with the tutorial.

Reply to this email directly or view it on GitHub: https://github.com/django-nonrel/docs/issues/3#issuecomment-3702223

dillongreen commented 12 years ago

"Not sure what to do with the tutorial"... Me neither but as I start wrapping my head around the whole "what needs to be done with regards to documentation" I am starting to think that maybe one place with a dedicated subsection for django + mongodb inside the new docs might be best (rather than basically having two urls: django-mongodb.org and readthedocs). Makes sense?

Why am I saying this? Because I am using django and mongodb, have been somewhat busy for the last four months and looking at our situation with regards to docs, I am getting confused about what we have where and what needs to be done to get rid of the chaos we currently have. For someone entirely new to using MongoDB and Django that must even be a lot worse :)

UPDATE: ha!, Flavio can read my minds... you posted while I was writting that comment, so yes, I am +1 on moving everything to the new docs as well I think... I will continue for one more day looking at the situation to familiarize myself again but it seems best to also move the tutorial etc. so we really have everything in one place.

dillongreen commented 12 years ago

I've started the mongodb-engine section in the new docs https://github.com/django-nonrel/docs/tree/feature/fromscratch/mongodb-engine I'll migrate stuff over the next two weeks or so.