Skip to content

Commit d166204

Browse files
committed
Match the main documentation page with the membership README
The FAQ and content sections will be broken off into separate pages.
1 parent 109aa5f commit d166204

File tree

1 file changed

+43
-4
lines changed

1 file changed

+43
-4
lines changed

docs/index.md

Lines changed: 43 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,46 @@
11
# Django Commons
22

3-
## Repositories
3+
Django Commons is an organization dedicated to supporting the community's efforts to maintain packages. It seeks to improve the maintenance experience for all contributors; reducing the barrier to entry for new contributors and reducing overhead for existing maintainers.
44

5-
- [django-commons/membership](https://github.com/django-commons/membership)
6-
- [django-commons/best-practices](https://github.com/django-commons/best-practices)
7-
- [django-commons/controls](https://github.com/django-commons/controls)
5+
Django Commons has lofty goals for the future, but it will only be possible with your help:
6+
7+
- Identify and announce packages needing help
8+
- Normalize and support maintainers periodically stepping back
9+
- Support and encourage new contributors to step up
10+
- Provide best practices for package maintainers
11+
- Compensate maintainers
12+
13+
## How to join as a contributor?
14+
15+
1. Review [Code of Conduct](https://github.com/django-commons/membership/blob/main/CODE_OF_CONDUCT.md)
16+
2. Create a [new member issue in the django-commons/membership repository](https://github.com/django-commons/membership/issues/new/choose).
17+
18+
## How to transfer a project in?
19+
20+
1. A person with the ability to transfer the project must join Django Commons (see [How to join as a contributor?](https://github.com/django-commons/membership#how-to-join-as-a-contributor))
21+
2. Create a [transfer project in issue in the django-commons/membership repository](https://github.com/django-commons/membership/issues/new/choose).
22+
23+
## How to transfer a project out?
24+
25+
1. Create a [transfer project out issue in the django-commons/membership repository](https://github.com/django-commons/membership/issues/new/choose).
26+
27+
## Projects
28+
29+
The following projects are maintained by the Django Commons community:
30+
31+
- [django-click](https://github.com/django-commons/django-click): Write Django management command using the click CLI library
32+
- [django-debug-toolbar](https://github.com/django-commons/django-debug-toolbar): A configurable set of panels that display various debug information about the current request/response.
33+
- [django-enum](https://github.com/django-commons/django-enum): Full and natural support for enumerations as Django model fields.
34+
- [drf-excel](https://github.com/django-commons/drf-excel): An XLSX spreadsheet renderer for Django REST Framework.
35+
- [django-fsm-2](https://github.com/django-commons/django-fsm-2): Django friendly finite state machine support
36+
- [django-tailwind-cli](https://github.com/django-commons/django-tailwind-cli): Django and Tailwind integration based on the prebuilt Tailwind CSS CLI.
37+
- [django-tasks-scheduler](https://github.com/django-commons/django-tasks-scheduler): Schedule async tasks using redis protocol. Redis/ValKey/Dragonfly or any broker using the redis protocol can be used.
38+
- [django-typer](https://github.com/django-commons/django-typer): Use Typer (type hints) to define the interface for your Django management commands.
39+
40+
### Internal projects
41+
42+
The following repositories are internal to Django Commons and are not actual libraries:
43+
44+
- [django-commons/membership](https://github.com/django-commons/membership): Membership repository for the django-commons organization.
45+
- [django-commons/best-practices](https://github.com/django-commons/best-practices): A sample project with best practices for Django Commons projects.
46+
- [django-commons/controls](https://github.com/django-commons/controls): The controls for managing Django Commons projects

0 commit comments

Comments
 (0)