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

v1.0.0 spring cleaning 2/2. Fix #170 #182

Merged
merged 6 commits into from
Jan 24, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 0 additions & 22 deletions .github/ISSUE_TEMPLATE/QUESTION.md

This file was deleted.

5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: "❓ Question"
url: https://github.com/torchbox/django-pattern-library/discussions
about: Use GitHub Discussions to get help with this project.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# [django-pattern-library](https://torchbox.github.io/django-pattern-library/)

[![PyPI](https://img.shields.io/pypi/v/django-pattern-library.svg)](https://pypi.org/project/django-pattern-library/) [![PyPI downloads](https://img.shields.io/pypi/dm/django-pattern-library.svg)](https://pypi.org/project/django-pattern-library/) [![Build status](https://github.com/torchbox/django-pattern-library/workflows/CI/badge.svg)](https://github.com/torchbox/django-pattern-library/actions) [![Total alerts](https://img.shields.io/lgtm/alerts/g/torchbox/django-pattern-library.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/torchbox/django-pattern-library/alerts/)
[![PyPI](https://img.shields.io/pypi/v/django-pattern-library.svg)](https://pypi.org/project/django-pattern-library/) [![PyPI downloads](https://img.shields.io/pypi/dm/django-pattern-library.svg)](https://pypi.org/project/django-pattern-library/) [![Build status](https://github.com/torchbox/django-pattern-library/workflows/CI/badge.svg)](https://github.com/torchbox/django-pattern-library/actions)

> UI pattern libraries for Django templates. Try our [online demo](https://torchbox.github.io/django-pattern-library/demo/).

Expand Down
15 changes: 15 additions & 0 deletions docs/community/support.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Help and support

If you need help with this project, here are things you should try.

## Documentation search

We take good care to document common use cases of the library, with examples and code snippets. We also document use cases that are known to not be well supported, with links to issues.

## GitHub search

GitHub’s [main search](https://github.com/torchbox/django-pattern-library/search?q=help) can find matches in existing issues, pull requests, and discussions. The [cs.github.com code search](https://cs.github.com/torchbox/django-pattern-library?q=help) is excellent to search within the repository.

## GitHub Discussions

No luck with the existing documentation and other search results? Open a new discussion in [GitHub Discussions](https://github.com/torchbox/django-pattern-library/discussions) for conversations relating to the project. This can be used for support requests, or high-level feature ideas that don’t fit well with our issue template.
4 changes: 4 additions & 0 deletions docs/reference/known-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,10 @@ See [#138](https://github.com/torchbox/django-pattern-library/issues/138). For e

This can’t be mocked for all usage of `include_block`.

## Jinja2 support

Or lack thereof! If you’re interested in this, please share your thoughts with us on [#180](https://github.com/torchbox/django-pattern-library/discussions/180).

## Past limitations

### No way to specify objects that have attributes and support iteration
Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ nav:
- 'Concepts': 'reference/concepts.md'
- 'Known issues': 'reference/known-issues.md'
- 'Community':
- 'Support': 'community/support.md'
- 'Related projects': 'community/related-projects.md'
- 'Code of conduct': 'community/code-of-conduct.md'
- 'Security policy': 'community/security-policy.md'
Expand Down
5 changes: 5 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,11 @@ exclude = [
'pattern_library/static/pattern_library/src/**/*',
]

[tool.poetry.urls]
"Demo" = "https://torchbox.github.io/django-pattern-library/demo/"
"Support" = "https://github.com/torchbox/django-pattern-library/discussions"
"Issues" = "https://github.com/torchbox/django-pattern-library/issues"

[tool.poetry.dependencies]
python = "^3.7"
Django = ">=2.2,<4.1"
Expand Down
3 changes: 3 additions & 0 deletions tests/settings/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -75,4 +75,7 @@
'django.middleware.clickjacking.XFrameOptionsMiddleware',
]

# Preparation for Django 5.0 change.
USE_TZ = False

GITHUB_PAGES_EXPORT = False
2 changes: 1 addition & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ whitelist_externals =
install_command =
./tox_install.sh {packages}
commands =
poetry run ./runtests.py
poetry run python -X dev -W error runtests.py
poetry run django-admin render_patterns --settings=tests.settings.dev --pythonpath=. --dry-run
deps =
dj22: Django>=2.2,<2.3
Expand Down