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.
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
Initial work on filling gaps in versioning docs #180
Initial work on filling gaps in versioning docs #180
Conversation
Added UML diagram to show Grouper and Content models
…ional/djangocms-versioning into FIL-848_versioning_docs
Conflicts: djangocms_versioning/admin.py djangocms_versioning/cms_config.py
author, created and modified dates etc. about each version. | ||
|
||
content model | ||
A model with a one2one relationship with the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I suggest add in the image that I put int the docs/_static
folder which illustrates this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Kunjal found this very helpful. Not sure if Glossary is the right place for it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can use https://www.sphinx-doc.org/en/master/usage/extensions/graphviz.html for that
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll have a go at adding a graphviz version of that diagram to the versioning integration page as that's really where I try to explain these concepts in more detail.
:return: A list with one element - the pk of the content type of the content model | ||
""" | ||
# TODO: Why on earth would this return a list which will always | ||
# have just one element? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This won't always have just one element - see PolymorphicVersionableItem._get_content_types.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
aaah, thanks! Will correct the docstring/comment.
docs/admin_architecture.rst
Outdated
Proxy models | ||
+++++++++++++ | ||
Versioning generates a `proxy model | ||
<https://docs.djangoproject.com/en/dev/topics/db/models/#proxy-models>`_ of Version |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you refer to :class:djangocms_versioning.models.Version
here? Think it makes sense in versioning, as this documentation gets quite complex
Overall really well done, there are some minor comments left |
No description provided.