Skip to content

Commit

Permalink
Update documentation (#530)
Browse files Browse the repository at this point in the history
* build: add [docs] dependencies group

* fix: Gargoyle is no longer supported

* fix: minor updates

* fix: remove deprecated easy install and jingo references

* fix: remove deprecated syncdb ref

* fix: remove ancient upgrading instructions

* Revert "fix: remove ancient upgrading instructions"

This reverts commit c3cafe1.

* fix: update broken link

* fix: remove unmaintained framework
  • Loading branch information
dancergraham authored Nov 16, 2024
1 parent 86a1ea5 commit b697b31
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 38 deletions.
15 changes: 2 additions & 13 deletions docs/about/why-waffle.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,31 +19,20 @@ Waffle :ref:`aims to <about-goals>`
Waffle has an `active community`_ and gets `fairly steady updates`_.


vs Gargoyle
===========

The other major, active feature flag tool for Django is Disqus's
Gargoyle_. Both support similar features, though Gargoyle offers more
options for building custom segments in exchange for some more
complexity and requirements.


Waffle in Production
====================

Despite its pre-1.0 version number, Waffle has been used in production
for years at places like Mozilla, Yipit and TodaysMeet.
Waffle has been used in production for years at places like Mozilla, Yipit and TodaysMeet.

- Mozilla (Support, MDN, Addons, etc)
- TodaysMeet
- Yipit

(If you're using Waffle in production and don't mind being included
here, let me know or add yourself in a pull request!)
here, let us know or add yourself in a pull request!)


.. _Feature flags: http://code.flickr.net/2009/12/02/flipping-out/
.. _several options: https://www.djangopackages.com/grids/g/feature-flip/
.. _active community: https://github.com/jazzband/django-waffle/graphs/contributors
.. _fairly steady updates: https://github.com/jazzband/django-waffle/pulse/monthly
.. _Gargoyle: https://github.com/disqus/gargoyle
23 changes: 3 additions & 20 deletions docs/starting/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,11 @@ met, installing Waffle is a simple process.
Getting Waffle
==============

Waffle is `hosted on PyPI`_ and can be installed with ``pip`` or
``easy_install``:
Waffle is `hosted on PyPI`_ and can be installed with ``pip``

.. code-block:: shell
$ pip install django-waffle
$ easy_install django-waffle
Waffle is also available `on GitHub`_. In general, ``master`` should be
stable, but use caution depending on unreleased versions.
Expand Down Expand Up @@ -80,33 +78,18 @@ With django-jinja_, add the extension to the ``extensions`` list::
# ...
]

With jingo_, add it to the ``JINJA_CONFIG['extensions']`` list::

JINJA_CONFIG = {
'extensions': [
# ...
'waffle.jinja.WaffleExtension',
],
# ...
}


.. _installation-settings-migrations:

Database Schema
===============

Waffle includes `Django migrations`_ for creating the correct database
schema. If using Django >= 1.7, simply run the ``migrate`` management
command after adding Waffle to ``INSTALLED_APPS``:
schema. Simply run the ``migrate`` management command after adding Waffle to
``INSTALLED_APPS``:

.. code-block:: shell
$ django-admin.py migrate
If you're using a version of Django without migrations, you can run
``syncdb`` to create the Waffle tables.

.. _Django migrations: https://docs.djangoproject.com/en/dev/topics/migrations/
.. _django-jinja: https://pypi.python.org/pypi/django-jinja/
.. _jingo: http://jingo.readthedocs.org/
6 changes: 2 additions & 4 deletions docs/testing/automated.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,8 @@ Tests that run in a separate process, such as Selenium tests, may not
have access to the test database or the ability to mock Waffle values.

For tests that make HTTP requests to the system-under-test (e.g. with
Selenium_ or PhantomJS_) the ``WAFFLE_OVERRIDE`` :ref:`setting
<starting-configuring>` makes it possible to control the value of any
*Flag* via the querystring.
Selenium_) the ``WAFFLE_OVERRIDE`` :ref:`setting <starting-configuring>`
makes it possible to control the value of any *Flag* via the querystring.

.. highlight:: http

Expand All @@ -72,4 +71,3 @@ or that it is "off"::
.. _mock: http://pypi.python.org/pypi/mock/
.. _fudge: http://farmdev.com/projects/fudge/
.. _Selenium: http://www.seleniumhq.org/
.. _PhantomJS: http://phantomjs.org/
2 changes: 1 addition & 1 deletion docs/testing/user.rst
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,6 @@ Wow, good work!
You can use similar methods to derive the impact on other factors.


.. _session variables: https://developers.google.com/analytics/devguides/collection/upgrade/reference/gajs-analyticsjs#custom-vars
.. _session variables: https://support.google.com/analytics/answer/9191807?hl=en
.. _#80: https://github.com/jazzband/django-waffle/issues/80
.. _StatsD: https://github.com/etsy/statsd
2 changes: 2 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ classifiers = [
]
requires-python = ">=3.8"
dependencies = ["django>=3.2"]
[project.optional-dependencies]
docs = ["sphinx"]

[project.urls]
Homepage = "http://github.com/django-waffle/django-waffle"
Expand Down

0 comments on commit b697b31

Please sign in to comment.