Skip to content
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

Merged

Conversation

monikasulik
Copy link
Contributor

No description provided.

docs/admin_architecture.rst Outdated Show resolved Hide resolved
docs/index.rst Show resolved Hide resolved
Added UML diagram to show Grouper and Content models
@monikasulik monikasulik changed the title Initial work on filling gaps in versioning docs WIP: Initial work on filling gaps in versioning docs Mar 21, 2019
@monikasulik monikasulik changed the title WIP: Initial work on filling gaps in versioning docs Initial work on filling gaps in versioning docs Apr 1, 2019
djangocms_versioning/admin.py Outdated Show resolved Hide resolved
djangocms_versioning/admin.py Outdated Show resolved Hide resolved
djangocms_versioning/admin.py Outdated Show resolved Hide resolved
djangocms_versioning/admin.py Outdated Show resolved Hide resolved
author, created and modified dates etc. about each version.

content model
A model with a one2one relationship with the
Copy link
Contributor

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.

Copy link
Contributor

Choose a reason for hiding this comment

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

See here: https://divio-ch.atlassian.net/wiki/spaces/FIL/pages/668041217/Gaps+Documentation#GapsDocumentation-djangocms-versioning(Divio)

Kunjal found this very helpful. Not sure if Glossary is the right place for it.

Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Contributor Author

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?
Copy link
Contributor

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.

Copy link
Contributor Author

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.

Proxy models
+++++++++++++
Versioning generates a `proxy model
<https://docs.djangoproject.com/en/dev/topics/db/models/#proxy-models>`_ of Version
Copy link
Contributor

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

@chaosk
Copy link
Contributor

chaosk commented Apr 2, 2019

Overall really well done, there are some minor comments left

@monikasulik monikasulik merged commit eaaaa7c into django-cms:master Apr 2, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants