django / django/djangoproject.com

Help text for foundation Meeting model fields

Open
#1,464 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

accessibility
Dominant language
Python
Stars
2k
Forks
1.1k
Avg merge
3d 10h
Merged PRs (30d)
33

Description

Since I only use the Meeting model’s form once a month, it’d really help to have instructions explaining how to use the different fields directly on the form, rather than having to document this separately.

Here’s the help text I’m currently thinking of:

  • TItle & slug: "Keep the default as-is"
  • Board attendees: "Make sure to choose the correct year"
  • Business Body: "Supports reStructuredText. See supported formatting"
  • Action items: help content for whole section – "aka todos. Combine the last meeting’s remaining action items, and add any new ones"

And a prominent note somewhere towards the top of the form:

[!NOTE]
Meeting notes go live and on RSS on Save, make sure to complete all relevant fields.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the foundation Meeting model and its form, then compare the named fields with the requested wording. Confirm the help text and prominent save/RSS note appear on the form, including the reStructuredText link.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.