.. This README is meant for consumption by humans and pypi. Pypi can render rst files so please do not use Sphinx features.
If you want to learn more about writing documentation, please check out: http://docs.plone.org/about/documentation_styleguide.html
This text does not appear on pypi or github. It is a comment.
.. image:: https://github.com/collective/collective.redirect301/actions/workflows/plone-package.yml/badge.svg
:target: https://github.com/collective/collective.redirect301/actions/workflows/plone-package.yml
.. image:: https://coveralls.io/repos/github/collective/collective.redirect301/badge.svg?branch=main
:target: https://coveralls.io/github/collective/collective.redirect301?branch=main
:alt: Coveralls
.. image:: https://codecov.io/gh/collective/collective.redirect301/branch/master/graph/badge.svg
:target: https://codecov.io/gh/collective/collective.redirect301
.. image:: https://img.shields.io/pypi/v/collective.redirect301.svg
:target: https://pypi.python.org/pypi/collective.redirect301/
:alt: Latest Version
.. image:: https://img.shields.io/pypi/status/collective.redirect301.svg
:target: https://pypi.python.org/pypi/collective.redirect301
:alt: Egg Status
.. image:: https://img.shields.io/pypi/pyversions/collective.redirect301.svg?style=plastic :alt: Supported - Python Versions
.. image:: https://img.shields.io/pypi/l/collective.redirect301.svg
:target: https://pypi.python.org/pypi/collective.redirect301/
:alt: License
======================
collective.redirect301
======================
Thanks to `plone.app.redirector`_ Plone saves all URL changes that happen in the content and redirects the user to the proper content url.
It also allows the content-editor to create custom URLs for the content.
When doing so Plone uses a `HTTP 302`_ status code to redirect the user to the new URL.
Sometimes you want those redirects to return a `HTTP 301`_ status code, signaling that the redirect is *Permanent*.
There was a philosophical discussion when the status code was decided and the decission was to return a *Temporary* redirect.
This addon product, when enabled, changes that behavior and allows returning a *Permanent* redirect in such cases.
Installation
------------
Install collective.redirect301 by adding it to your buildout::
[buildout]
...
eggs =
collective.redirect301
and then running ``bin/buildout``
Finally you need to go to the Plone Addons Controlpanel and install the product there.
Authors
-------
- Lur Ibargutxi <libargutxi@codesyntax.com>
Contribute
----------
- Issue Tracker: https://github.com/collective/collective.redirect301/issues
- Source Code: https://github.com/collective/collective.redirect301
Support
-------
If you are having issues, please let us know.
License
-------
The project is licensed under the GPLv2.
.. _`HTTP 302`: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/302
.. _`HTTP 301`: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/301
.. _`plone.app.redirector`: https://pypi.org/project/plone.app.redirector/
Contributors
============
- Lur Ibargutxi, libargutxi@codesyntax.com
Changelog
=========
1.0 (2023-07-19)
----------------
- Initial release.
[libargutxi]
Raw data
{
"_id": null,
"home_page": "https://github.com/collective/collective.redirect301",
"name": "collective.redirect301",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "Python Plone CMS",
"author": "Lur Ibargutxi",
"author_email": "libargutxi@codesyntax.com",
"download_url": "https://files.pythonhosted.org/packages/01/cb/ce814f9456d7afb7d2addda9d98c185095fbd159081567a9511b407a15c7/collective.redirect301-1.0.tar.gz",
"platform": null,
"description": ".. This README is meant for consumption by humans and pypi. Pypi can render rst files so please do not use Sphinx features.\n If you want to learn more about writing documentation, please check out: http://docs.plone.org/about/documentation_styleguide.html\n This text does not appear on pypi or github. It is a comment.\n\n.. image:: https://github.com/collective/collective.redirect301/actions/workflows/plone-package.yml/badge.svg\n :target: https://github.com/collective/collective.redirect301/actions/workflows/plone-package.yml\n\n.. image:: https://coveralls.io/repos/github/collective/collective.redirect301/badge.svg?branch=main\n :target: https://coveralls.io/github/collective/collective.redirect301?branch=main\n :alt: Coveralls\n\n.. image:: https://codecov.io/gh/collective/collective.redirect301/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/collective/collective.redirect301\n\n.. image:: https://img.shields.io/pypi/v/collective.redirect301.svg\n :target: https://pypi.python.org/pypi/collective.redirect301/\n :alt: Latest Version\n\n.. image:: https://img.shields.io/pypi/status/collective.redirect301.svg\n :target: https://pypi.python.org/pypi/collective.redirect301\n :alt: Egg Status\n\n.. image:: https://img.shields.io/pypi/pyversions/collective.redirect301.svg?style=plastic :alt: Supported - Python Versions\n\n.. image:: https://img.shields.io/pypi/l/collective.redirect301.svg\n :target: https://pypi.python.org/pypi/collective.redirect301/\n :alt: License\n\n\n======================\ncollective.redirect301\n======================\n\nThanks to `plone.app.redirector`_ Plone saves all URL changes that happen in the content and redirects the user to the proper content url.\n\nIt also allows the content-editor to create custom URLs for the content.\n\nWhen doing so Plone uses a `HTTP 302`_ status code to redirect the user to the new URL.\n\nSometimes you want those redirects to return a `HTTP 301`_ status code, signaling that the redirect is *Permanent*.\n\nThere was a philosophical discussion when the status code was decided and the decission was to return a *Temporary* redirect.\n\nThis addon product, when enabled, changes that behavior and allows returning a *Permanent* redirect in such cases.\n\n\nInstallation\n------------\n\nInstall collective.redirect301 by adding it to your buildout::\n\n [buildout]\n\n ...\n\n eggs =\n collective.redirect301\n\n\nand then running ``bin/buildout``\n\n\nFinally you need to go to the Plone Addons Controlpanel and install the product there.\n\n\nAuthors\n-------\n\n- Lur Ibargutxi <libargutxi@codesyntax.com>\n\n\nContribute\n----------\n\n- Issue Tracker: https://github.com/collective/collective.redirect301/issues\n- Source Code: https://github.com/collective/collective.redirect301\n\n\nSupport\n-------\n\nIf you are having issues, please let us know.\n\n\nLicense\n-------\n\nThe project is licensed under the GPLv2.\n\n.. _`HTTP 302`: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/302\n.. _`HTTP 301`: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/301\n.. _`plone.app.redirector`: https://pypi.org/project/plone.app.redirector/\n\nContributors\n============\n\n- Lur Ibargutxi, libargutxi@codesyntax.com\n\n\nChangelog\n=========\n\n\n1.0 (2023-07-19)\n----------------\n\n- Initial release.\n [libargutxi]\n",
"bugtrack_url": null,
"license": "GPL version 2",
"summary": "An add-on for Plone",
"version": "1.0",
"project_urls": {
"Homepage": "https://github.com/collective/collective.redirect301",
"PyPI": "https://pypi.python.org/pypi/collective.redirect301",
"Source": "https://github.com/collective/collective.redirect301",
"Tracker": "https://github.com/collective/collective.redirect301/issues"
},
"split_keywords": [
"python",
"plone",
"cms"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "01cbce814f9456d7afb7d2addda9d98c185095fbd159081567a9511b407a15c7",
"md5": "09159fbf875a4c856ea922674d14330e",
"sha256": "eea68db4a249ce828ad2e8e760194e8b34ec624f7b484cec459300f3394be217"
},
"downloads": -1,
"filename": "collective.redirect301-1.0.tar.gz",
"has_sig": false,
"md5_digest": "09159fbf875a4c856ea922674d14330e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 23829,
"upload_time": "2023-07-19T08:37:35",
"upload_time_iso_8601": "2023-07-19T08:37:35.907080Z",
"url": "https://files.pythonhosted.org/packages/01/cb/ce814f9456d7afb7d2addda9d98c185095fbd159081567a9511b407a15c7/collective.redirect301-1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-19 08:37:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "collective",
"github_project": "collective.redirect301",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "collective.redirect301"
}