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

Corrected plugin documentations based on Issue #6752 #6798

Merged
merged 5 commits into from May 24, 2020

Conversation

MLK97
Copy link

@MLK97 MLK97 commented Jan 23, 2020

Description

Updated the For many-to-many or foreign key relations to other objects section as mentioned in issue #6752

Related resources

This pull request is motivated by Issue #6752

Fix #6752

Checklist

  • I have opened this pull request against develop
  • I have updated the CHANGELOG.rst
  • I have added or modified the tests when changing logic

@MLK97 MLK97 requested a review from yakky January 23, 2020 22:59
@yakky yakky added this to the 3.7.x milestone May 24, 2020
@coveralls
Copy link

Coverage Status

Coverage remained the same at 78.215% when pulling d3c4843 on MLK97:DOC_correction_plugin into fb886f6 on divio:develop.

@yakky yakky merged commit 199e306 into django-cms:develop May 24, 2020
@yakky yakky added the backport Commits are being back ported label May 25, 2020
FinalAngel pushed a commit to FinalAngel/django-cms that referenced this pull request May 26, 2020
FinalAngel added a commit that referenced this pull request May 26, 2020
Co-authored-by: Maximilian Konrad <maximilianlukaskonrad@hotmail.de>
FinalAngel added a commit that referenced this pull request Jul 21, 2020
* Add missing parenthesis in code (#6677) (#6690)

* Adding support for Django 2.2 LTS (#6655) (#6691)

* New changes for cms 3.7

* Fix typo

* Fixed issue with force_color

* Removed unused import

* Added docs to index.rst

* Fixed travis jobs

* Fixed force_color command

* Changes after review

* Fixed django version in setup

* Update django-2.2.txt

* Fixes test suite (#6688) (#6692)

* add information for testing

* fix tests

* updated CHANGELOG

* update

* 1.8.5

* fix tests locally

* update text

* Release 3.7.0a1 (internal) (#6693)

* bumped version to 3.7.0a1

* updated staticfiles

* updated translations

* Adapt test suite for recent Travis changes (#6709) (#6710)

* test something

* further updates and add 3.7 to test

* updates

* simplify for tests

* add 3.7 support

* Fix content mode related to #6694 (#6696) (#6711)

* Adapt test suite for recent Travis changes (#6709)

* test something

* further updates and add 3.7 to test

* updates

* simplify for tests

* add 3.7 support

* Fix content mode related to #6694 (#6696)

* Fix content mode related to #6694

* Add Dmytro Litvinov to AUTHORS according to PR template

* Self install doc tweaks (#6673) (#6712)

* Adapt test suite for recent Travis changes (#6709)

* test something

* further updates and add 3.7 to test

* updates

* simplify for tests

* add 3.7 support

* Fix content mode related to #6694 (#6696)

* Fix content mode related to #6694

* Add Dmytro Litvinov to AUTHORS according to PR template

* Self install doc tweaks (#6673)

* Add missing template context processor to self install docs

Fixes #5828

* Reword self install docs for clarity

* Add to AUTHORS file

* Documenation: Add 'prepopulated_fields' to ignored options list on CMSPluginBase (#6667) (#6713)

* Add 'prepopulated_fields' to ignore list

Added `prepopulated_fields` to the list of options that will be ignored when creating a custom DjangoCMS plugin with CMSPluginBase (which is based on ModelAdmin)

* Update AUTHORS

* Release 3.7.0rc1 (#6715)

* update django version in sphinx

* bumped version

* updated existing translations

* update static files

* update docs

* update authors file

* Override urlconf_module so that Django system checks don't crash. (#6719) (#6723)

* Add a test case for #6717.

* Override urlconf_module so that Django system checks don't crash.

Without this fix, Django system checks in Django 2.2 will try to resolve the
"app_resolver" module, which does not exist. Overriding ``urlconf_module``
prevents the issue.

Fixes #6717

* Release 3.7.0rc2 (#6724)

* regenerated translation files

* bumped version

* update existing translation

* compile static files

* updated release notes

* Updated compatibility table (#6727)

* Release 3.7.0 (#6735)

* Bumped version to 3.7.0

* updated translation files

* added static files

* Backport to prepare for 3.7.1 (#6762)

* Improved and simplified permissions documentation (#6224)

[ci-skip]

* Updated branch policy (#6320)

* Updated branch policy

[ci only docs]

* Removed feature branch notes from policy

* Improve apphooks documentation (#6743)

Remove a reference to `urls` attribute on AppHook class in the documentation.

* Fix documentation bug regarding CMSPluginBase (#6744)

The documentation advertises that you can set the module attribute of
custom plugins to None.  If the user attempts this django they won't be able
to start up when django.contrib.admin.site.urls is included in urls.py
(tested with django 1.11.25 and django-cms 3.7.0).

* Added example of `get_plugin_instance` to the docs on nested plugins. (#6609)

* Amend Changelog and fixes from merged PRs (#6755)

* add missing changelog entries

* update docs

* updated changelog

* updates from comments

* Sites - Pass Site obj instead of pk when creating a StaticPlaceholder (#6679)

* Pass site object instead of pk when rendering menu

Add original fix by @saqlainsyed007

* Moved test to it's own class

* Update changelog

* Do not let non-staff users to log in via CMS Toolbar (#6705)

* Merged stale PR's (#6759)

* add missing changelog entries

* update docs

* updated changelog

* updates from comments

* merge #6347

* merged #6530

* merge #6538

* merge #6549

* merge #6704

* changelog for #6705

* Update issue templates

* Fixed #6737 -- Fix 'urls.W001' warning with custom apphook urls (#6738)

* Refs #6737 -- Add test for apphooks urls config check

* Fixed #6737 -- Fix 'urls.W001' warning with custom apphook urls

When rewriting the apphooks urls in appresolver.recurse_patterns,
the original RegexPattern.is_endpoint flag is lost, so urls with a callback
view throws an "include with a route ending with a '$'" warning ('urls.W001').

    @apphook_pool.register
    class MyApp(CMSApp):
        name = "MyApp"

        def get_urls(self, page=None, language=None, **kwargs):
            return [
                re_path(r"^$", views.MyAppView.as_view(), name="my-app-index")
                # or this
                # path(r"", views.MyAppView.as_view(), name="my-app-index")
            ]

    $ ./manage.py check
    System check identified some issues:

    WARNINGS:
    ?: (urls.W001) Your URL pattern '^my-app-url/my-view-url/$' [name='my-app-index']
    uses include with a route ending with a '$'. Remove the dollar from the
    route to avoid problems including URLs.

This fix set the RegexPattern flag is_endpoint to True for callback views
in appresolver.recurse_patterns as in
https://github.com/django/django/blob/stable/2.2.x/django/urls/conf.py#L70

* Updated documentation and files for 3.7 LTS (#6761)

* general updates

* updates from comments

* update form comments

* Further backports for 3.7.1 (#6768)

* add newly generated strings

* Fix simple typo: seperated -> separated (#6767)

* Fix simple typo: seperated -> separated

* Update CHANGELOG.rst

* Update djangocms installer docs (#6764)

* Release django CMS 3.7.1 (#6769)

* update documentation

* Bumped version to 3.7.1

* compiled available languages

* update static files

* fix build

* bump date

* Update 04-plugins.rst (#6782)

Migration does not work without on_delete on a ForeignKey-Field

* Backport changes to 3.7.x (#6837)

* Add Django 3 and Python 3.8 support (#6796)

* release version lock

* remove python_2_unicode_compatible

* migrated from ``django.utils.six`` to the six package

* more migrations

* update static import

* update to TemplateResponse

* add new arguments

* re-add unicode

* further adaptions

* fix additional issues

* update test framework

* update docs

* revert this change

* add space

* adapt upgrade docs

* fix tests

* test updates

* easy dependency

* adapt requirements files

* cleanup tests

* minor update

* revert pyflakes

* test something

* another test

* updates

* fix some tests

* tests

* Usage of session to store user language has been deprecated

* Fix pyflakes support

* Fix on py2.7

Co-authored-by: Iacopo Spalletti <i.spalletti@nephila.it>
# Conflicts:
#	docs/introduction/09-third_party.rst

* Improved plugins documentation

# Conflicts:
#	docs/how_to/custom_plugins.rst

Co-authored-by: Daniele Procida <daniele@vurt.org>

* Release 3.7.2 (#6838)

* updated translations

* Bumped version to 3.7.2

* update existing translations

* rebuild static files

* update changelog

* Updated compatibility table for 3.7.2

Co-authored-by: Daniele Procida <daniele@vurt.org>

* Corrected plugin documentations based on Issue #6752 (#6798) (#6858)

Co-authored-by: Maximilian Konrad <maximilianlukaskonrad@hotmail.de>

* Move var declaration inside closure to make it available to firefox (#6854) (#6859)

# Conflicts:
#	CHANGELOG.rst

Co-authored-by: Iacopo Spalletti <i.spalletti@nephila.digital>

* Fix 3.7 on python 2 (#6855) (#6860)

* Fix imports on python 2.7
* Fix requirements
* Make python 2.7 required on travis
* Fix url cache leak in tests
* Remove references to MIDDLEWARE_CLASSES
* Update changelog

Co-authored-by: Iacopo Spalletti <i.spalletti@nephila.digital>

* set white of first column in jstree to normal (#6856) (#6861)

# Conflicts:
#	cms/static/cms/css/3.7.2/cms.pagetree.css

Co-authored-by: Jacob Rief <jacob.rief@gmail.com>

* Release 3.7.3 (#6862)

* generate translations

* Bumped version to 3.7.3

* compile translations

* upgrade static assets

* update docs

* add release date

* Release 3.7.4 (#6881)

* add patch

* bumdle

* bump version

* regenerate build files

Co-authored-by: Daniele Procida <daniele@vurt.org>
Co-authored-by: datencoach <51292314+datencoach@users.noreply.github.com>
Co-authored-by: Maximilian Konrad <maximilianlukaskonrad@hotmail.de>
Co-authored-by: Iacopo Spalletti <i.spalletti@nephila.digital>
Co-authored-by: Jacob Rief <jacob.rief@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport Commits are being back ported component: documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update to Documentation required
4 participants