Skip to content

Commit 109aa5f

Browse files
committed
Add FAQ and Media/Content pages
1 parent 3ecd599 commit 109aa5f

File tree

3 files changed

+71
-1
lines changed

3 files changed

+71
-1
lines changed

docs/faq.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Frequently Asked Questions
2+
3+
## What are the differences between Django Commons and Jazzband?
4+
5+
Django Commons and Jazzband have similar goals, to support community-maintained projects.
6+
There are two main differences. The first is that Django Commons leans into the GitHub
7+
paradigm and centers the organization as a whole within GitHub. This is a risk, given
8+
there's some vendor lock-in. However, the repositories are still cloned to several people's
9+
machines and the organization controls the keys to PyPI, not GitHub. If something were to occur,
10+
it's manageable.
11+
12+
The second is that Django Commons is built from the beginning to have more than one administrator.
13+
Jazzband has been [working for a while to add additional roadies](https://github.com/jazzband/help/issues/196)
14+
(administrators), but there hasn't been visible progress. Given the importance of several of
15+
these projects, it's a major risk to the community at large to have a single point of failure
16+
in managing the projects. By being designed from the start to spread the responsibility, it
17+
becomes easier to allow people to step back and others to step up, making Django more sustainable
18+
and the community stronger.
19+
20+
## What is each repository team for?
21+
22+
There are three teams for each repository. They each have different
23+
permissions.
24+
25+
- [project-name]
26+
- [project-name]-committers
27+
- [project-name]-admins
28+
29+
The general team [project-name] gives you triage permissions (assign issues, labels, etc).
30+
31+
The [project-name]-committers gives you permission to merge pull requests and push to main.
32+
They are people who generally maintain the project.
33+
34+
The [project-name]-admins gives you permissions to administrate the GitHub repo and release new versions to PyPI.
35+
This may be the same group of people that are on [project-name]-commiters.
36+
37+
## Who can work on a project?
38+
39+
Anyone can fork any project and work on any issue. All projects within Django Commons are community
40+
maintained. If you're interested in working on a specific project, go get to work!
41+
42+
## Which repository is for what?
43+
44+
- [controls](https://github.com/django-commons/controls): This is for Django Commons administrators
45+
to manage the GitHub organization. Any issues in this repo are for maintain the magic behind the scenes
46+
- [best-practices](https://github.com/django-commons/best-practices): A sample project with best practices for Django Commons projects.
47+
- [membership](https://github.com/django-commons/membership): The public face for the organization. All issues by members and contributors should be created
48+
here. **If you're looking for where to ask a question, this is the place for you**
49+
-
50+
### Do we allow all packages or just Django-adjacent?
51+
52+
Any package is welcome to join Django Commons so long as it has tangible benefits to the Django Community at large and the package benefits from being part of Django Commons OR it is about Django Specifically.

docs/media.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
## Django Commons content
2+
3+
Below is a collection of Django Commons content. They may be blog posts, videos or podcasts. If you've mentioned Django Commons, please let us know and we'll get it added to the list!
4+
5+
- [Django Commons YouTube](https://www.youtube.com/@djangocommons)
6+
- [Django Tasks Scheduler project overview with Daniel Moran](https://www.youtube.com/watch?v=Brfavid_fxw) [Daniel Moran](https://github.com/cunla) provides an introduction of django-tasks-scheduler to Ryan Cheley and Tim Schilling.
7+
- [Django Brew Episode 4: Spoiler Alert: DjangoCon US Recap, Open Source Maintenance, and Other Spooky Stories](https://djangobrew.com/episodes/16285007-episode-4-spoiler-alert-djangocon-us-recap-open-source-maintenance-and-other-spooky-stories)
8+
- ["Endorsing Django Packages"](https://softwarecrafts.uk/100-words/day-246) by [Andy Miller](https://github.com/nanorepublica/)
9+
- ["Django Commons"](https://www.ryancheley.com/2024/10/23/django-commons/) by [Ryan Cheley](https://github.com/ryancheley/):
10+
An introduction to Django Commons, explaining its goals, structure, and benefits for maintainers.
11+
- ["Django Commons"](https://simonwillison.net/2024/Oct/8/django-commons/) by Simon Willison:
12+
Simon highlights Django Commons on his blog and what he's looking forward to.
13+
- ["Introducing Django Commons!"](https://2024.djangocon.us/talks/lightning-talks-tuesday/) by [Lacey Henschel](https://github.com/williln):
14+
A lightning talk from DjangoCon US 2024 introducing Django Commons.
15+
- ["Django Commons - A home for community-maintained Django packages"](https://www.better-simple.com/django/2024/05/22/looking-for-help-django-commons/) by [Tim Schilling](https://github.com/tim-schilling/):
16+
A call for help to start Django Commons.

mkdocs.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,7 @@ markdown_extensions:
55
permalink: "#"
66
nav:
77
- Home: index.md
8+
- FAQ: faq.md
89
- Governance: governance.md
9-
- Values: values.md
10+
- Media: media.md
11+
- Values: values.md

0 commit comments

Comments
 (0)