Update help text (most the way there)

This commit is contained in:
zandercymatics 2024-04-12 15:34:01 -06:00
parent 64d0ec3f93
commit 30eed60413
No known key found for this signature in database
GPG key ID: FF4636ABEC9682B7
5 changed files with 18 additions and 50 deletions

View file

@ -992,20 +992,19 @@ class Domain(TimeStampedModel, DomainHelper):
blank=False, blank=False,
default=None, # prevent saving without a value default=None, # prevent saving without a value
unique=True, unique=True,
help_text="Fully qualified domain name",
) )
state = FSMField( state = FSMField(
max_length=21, max_length=21,
choices=State.choices, choices=State.choices,
default=State.UNKNOWN, default=State.UNKNOWN,
protected=True, # cannot change state directly, particularly in Django admin # cannot change state directly, particularly in Django admin
help_text="Very basic info about the lifecycle of this domain object", protected=True,
) )
expiration_date = DateField( expiration_date = DateField(
null=True, null=True,
help_text=("Duplication of registry's expiration date saved for ease of reporting"), help_text=("Date the domain expires in the registry"),
) )
security_contact_registry_id = TextField( security_contact_registry_id = TextField(
@ -1017,13 +1016,13 @@ class Domain(TimeStampedModel, DomainHelper):
deleted = DateField( deleted = DateField(
null=True, null=True,
editable=False, editable=False,
help_text="Deleted at date", help_text="Will appear blank unless the domain is in \"deleted\" state",
) )
first_ready = DateField( first_ready = DateField(
null=True, null=True,
editable=False, editable=False,
help_text="The last time this domain moved into the READY state", help_text="Date when this domain first moved into \"ready\" state; date will never change",
) )
def isActive(self): def isActive(self):

View file

@ -37,6 +37,7 @@ class DomainInformation(TimeStampedModel):
"registrar.User", "registrar.User",
on_delete=models.PROTECT, on_delete=models.PROTECT,
related_name="information_created", related_name="information_created",
help_text="Person who submitted the domain request",
) )
domain_request = models.OneToOneField( domain_request = models.OneToOneField(
@ -45,7 +46,7 @@ class DomainInformation(TimeStampedModel):
blank=True, blank=True,
null=True, null=True,
related_name="DomainRequest_info", related_name="DomainRequest_info",
help_text="Associated domain request", help_text="Request associated with this domain",
unique=True, unique=True,
) )
@ -62,7 +63,6 @@ class DomainInformation(TimeStampedModel):
is_election_board = models.BooleanField( is_election_board = models.BooleanField(
null=True, null=True,
blank=True, blank=True,
help_text="Is your organization an election office?",
) )
# TODO - Ticket #1911: stub this data from DomainRequest # TODO - Ticket #1911: stub this data from DomainRequest
@ -76,25 +76,21 @@ class DomainInformation(TimeStampedModel):
federally_recognized_tribe = models.BooleanField( federally_recognized_tribe = models.BooleanField(
null=True, null=True,
help_text="Is the tribe federally recognized",
) )
state_recognized_tribe = models.BooleanField( state_recognized_tribe = models.BooleanField(
null=True, null=True,
help_text="Is the tribe recognized by a state",
) )
tribe_name = models.CharField( tribe_name = models.CharField(
null=True, null=True,
blank=True, blank=True,
help_text="Name of tribe",
) )
federal_agency = models.CharField( federal_agency = models.CharField(
choices=AGENCY_CHOICES, choices=AGENCY_CHOICES,
null=True, null=True,
blank=True, blank=True,
help_text="Federal agency",
) )
federal_type = models.CharField( federal_type = models.CharField(
@ -102,7 +98,6 @@ class DomainInformation(TimeStampedModel):
choices=BranchChoices.choices, choices=BranchChoices.choices,
null=True, null=True,
blank=True, blank=True,
help_text="Federal government branch",
) )
is_election_board = models.BooleanField( is_election_board = models.BooleanField(
@ -114,52 +109,45 @@ class DomainInformation(TimeStampedModel):
organization_name = models.CharField( organization_name = models.CharField(
null=True, null=True,
blank=True, blank=True,
help_text="Organization name",
db_index=True, db_index=True,
) )
address_line1 = models.CharField( address_line1 = models.CharField(
null=True, null=True,
blank=True, blank=True,
help_text="Street address",
verbose_name="Street address", verbose_name="Street address",
) )
address_line2 = models.CharField( address_line2 = models.CharField(
null=True, null=True,
blank=True, blank=True,
help_text="Street address line 2 (optional)",
verbose_name="Street address line 2 (optional)", verbose_name="Street address line 2 (optional)",
) )
city = models.CharField( city = models.CharField(
null=True, null=True,
blank=True, blank=True,
help_text="City",
) )
state_territory = models.CharField( state_territory = models.CharField(
max_length=2, max_length=2,
choices=StateTerritoryChoices.choices, choices=StateTerritoryChoices.choices,
null=True, null=True,
blank=True, blank=True,
help_text="State, territory, or military post",
verbose_name="State, territory, or military post", verbose_name="State, territory, or military post",
) )
zipcode = models.CharField( zipcode = models.CharField(
max_length=10, max_length=10,
null=True, null=True,
blank=True, blank=True,
help_text="Zip code",
db_index=True, db_index=True,
) )
urbanization = models.CharField( urbanization = models.CharField(
null=True, null=True,
blank=True, blank=True,
help_text="Urbanization (required for Puerto Rico only)", help_text="Required for Puerto Rico only",
verbose_name="Urbanization (required for Puerto Rico only)", verbose_name="Urbanization (required for Puerto Rico only)",
) )
about_your_organization = models.TextField( about_your_organization = models.TextField(
null=True, null=True,
blank=True, blank=True,
help_text="Information about your organization",
) )
authorizing_official = models.ForeignKey( authorizing_official = models.ForeignKey(
@ -177,7 +165,6 @@ class DomainInformation(TimeStampedModel):
null=True, null=True,
# Access this information via Domain as "domain.domain_info" # Access this information via Domain as "domain.domain_info"
related_name="domain_info", related_name="domain_info",
help_text="Domain to which this information belongs",
) )
# This is the contact information provided by the domain requestor. The # This is the contact information provided by the domain requestor. The
@ -188,6 +175,7 @@ class DomainInformation(TimeStampedModel):
blank=True, blank=True,
related_name="submitted_domain_requests_information", related_name="submitted_domain_requests_information",
on_delete=models.PROTECT, on_delete=models.PROTECT,
help_text="Person listed under \"your contact information\" in the request form",
) )
purpose = models.TextField( purpose = models.TextField(
@ -206,13 +194,12 @@ class DomainInformation(TimeStampedModel):
no_other_contacts_rationale = models.TextField( no_other_contacts_rationale = models.TextField(
null=True, null=True,
blank=True, blank=True,
help_text="Reason for listing no additional contacts", help_text="Required if creator does not list other employees",
) )
anything_else = models.TextField( anything_else = models.TextField(
null=True, null=True,
blank=True, blank=True,
help_text="Anything else?",
) )
is_policy_acknowledged = models.BooleanField( is_policy_acknowledged = models.BooleanField(
@ -224,7 +211,6 @@ class DomainInformation(TimeStampedModel):
notes = models.TextField( notes = models.TextField(
null=True, null=True,
blank=True, blank=True,
help_text="Notes about the request",
) )
def __str__(self): def __str__(self):

View file

@ -455,6 +455,7 @@ class DomainRequest(TimeStampedModel):
"registrar.User", "registrar.User",
on_delete=models.PROTECT, on_delete=models.PROTECT,
related_name="domain_requests_created", related_name="domain_requests_created",
help_text="Person who submitted the domain request; will not receive email updates",
) )
investigator = models.ForeignKey( investigator = models.ForeignKey(
@ -472,13 +473,11 @@ class DomainRequest(TimeStampedModel):
choices=OrganizationChoices.choices, choices=OrganizationChoices.choices,
null=True, null=True,
blank=True, blank=True,
help_text="Type of organization",
) )
is_election_board = models.BooleanField( is_election_board = models.BooleanField(
null=True, null=True,
blank=True, blank=True,
help_text="Is your organization an election office?",
) )
# TODO - Ticket #1911: stub this data from DomainRequest # TODO - Ticket #1911: stub this data from DomainRequest
@ -492,25 +491,21 @@ class DomainRequest(TimeStampedModel):
federally_recognized_tribe = models.BooleanField( federally_recognized_tribe = models.BooleanField(
null=True, null=True,
help_text="Is the tribe federally recognized",
) )
state_recognized_tribe = models.BooleanField( state_recognized_tribe = models.BooleanField(
null=True, null=True,
help_text="Is the tribe recognized by a state",
) )
tribe_name = models.CharField( tribe_name = models.CharField(
null=True, null=True,
blank=True, blank=True,
help_text="Name of tribe",
) )
federal_agency = models.CharField( federal_agency = models.CharField(
choices=AGENCY_CHOICES, choices=AGENCY_CHOICES,
null=True, null=True,
blank=True, blank=True,
help_text="Federal agency",
) )
federal_type = models.CharField( federal_type = models.CharField(
@ -518,57 +513,49 @@ class DomainRequest(TimeStampedModel):
choices=BranchChoices.choices, choices=BranchChoices.choices,
null=True, null=True,
blank=True, blank=True,
help_text="Federal government branch",
) )
organization_name = models.CharField( organization_name = models.CharField(
null=True, null=True,
blank=True, blank=True,
help_text="Organization name",
db_index=True, db_index=True,
) )
address_line1 = models.CharField( address_line1 = models.CharField(
null=True, null=True,
blank=True, blank=True,
help_text="Street address",
verbose_name="Address line 1", verbose_name="Address line 1",
) )
address_line2 = models.CharField( address_line2 = models.CharField(
null=True, null=True,
blank=True, blank=True,
help_text="Street address line 2 (optional)",
verbose_name="Address line 2", verbose_name="Address line 2",
) )
city = models.CharField( city = models.CharField(
null=True, null=True,
blank=True, blank=True,
help_text="City",
) )
state_territory = models.CharField( state_territory = models.CharField(
max_length=2, max_length=2,
choices=StateTerritoryChoices.choices, choices=StateTerritoryChoices.choices,
null=True, null=True,
blank=True, blank=True,
help_text="State, territory, or military post",
) )
zipcode = models.CharField( zipcode = models.CharField(
max_length=10, max_length=10,
null=True, null=True,
blank=True, blank=True,
help_text="Zip code",
db_index=True, db_index=True,
) )
urbanization = models.CharField( urbanization = models.CharField(
null=True, null=True,
blank=True, blank=True,
help_text="Urbanization (required for Puerto Rico only)", help_text="Required for Puetro Rico only",
) )
about_your_organization = models.TextField( about_your_organization = models.TextField(
null=True, null=True,
blank=True, blank=True,
help_text="Information about your organization",
) )
authorizing_official = models.ForeignKey( authorizing_official = models.ForeignKey(
@ -591,7 +578,7 @@ class DomainRequest(TimeStampedModel):
"Domain", "Domain",
null=True, null=True,
blank=True, blank=True,
help_text="The approved domain", help_text="Domain associated with this request; will be blank until request is approved",
related_name="domain_request", related_name="domain_request",
on_delete=models.SET_NULL, on_delete=models.SET_NULL,
) )
@ -600,7 +587,6 @@ class DomainRequest(TimeStampedModel):
"DraftDomain", "DraftDomain",
null=True, null=True,
blank=True, blank=True,
help_text="The requested domain",
related_name="domain_request", related_name="domain_request",
on_delete=models.PROTECT, on_delete=models.PROTECT,
) )
@ -609,6 +595,7 @@ class DomainRequest(TimeStampedModel):
"registrar.Website", "registrar.Website",
blank=True, blank=True,
related_name="alternatives+", related_name="alternatives+",
help_text="Other domain names the creator provided for consideration",
) )
# This is the contact information provided by the domain requestor. The # This is the contact information provided by the domain requestor. The
@ -619,12 +606,12 @@ class DomainRequest(TimeStampedModel):
blank=True, blank=True,
related_name="submitted_domain_requests", related_name="submitted_domain_requests",
on_delete=models.PROTECT, on_delete=models.PROTECT,
help_text="Person listed under \"your contact information\" in the request form; will receive email updates"
) )
purpose = models.TextField( purpose = models.TextField(
null=True, null=True,
blank=True, blank=True,
help_text="Purpose of your domain",
) )
other_contacts = models.ManyToManyField( other_contacts = models.ManyToManyField(
@ -637,13 +624,12 @@ class DomainRequest(TimeStampedModel):
no_other_contacts_rationale = models.TextField( no_other_contacts_rationale = models.TextField(
null=True, null=True,
blank=True, blank=True,
help_text="Reason for listing no additional contacts", help_text="Required if creator does not list other employees",
) )
anything_else = models.TextField( anything_else = models.TextField(
null=True, null=True,
blank=True, blank=True,
help_text="Anything else?",
) )
is_policy_acknowledged = models.BooleanField( is_policy_acknowledged = models.BooleanField(
@ -663,7 +649,6 @@ class DomainRequest(TimeStampedModel):
notes = models.TextField( notes = models.TextField(
null=True, null=True,
blank=True, blank=True,
help_text="Notes about this request",
) )
def save(self, *args, **kwargs): def save(self, *args, **kwargs):

View file

@ -21,14 +21,13 @@ class Host(TimeStampedModel):
blank=False, blank=False,
default=None, # prevent saving without a value default=None, # prevent saving without a value
unique=False, unique=False,
help_text="Fully qualified domain name",
) )
domain = models.ForeignKey( domain = models.ForeignKey(
"registrar.Domain", "registrar.Domain",
on_delete=models.PROTECT, on_delete=models.PROTECT,
related_name="host", # access this Host via the Domain as `domain.host` related_name="host", # access this Host via the Domain as `domain.host`
help_text="Domain to which this host belongs", help_text="Domain associated with this hosts",
) )
def __str__(self): def __str__(self):

View file

@ -20,12 +20,11 @@ class HostIP(TimeStampedModel):
blank=False, blank=False,
default=None, # prevent saving without a value default=None, # prevent saving without a value
validators=[validate_ipv46_address], validators=[validate_ipv46_address],
help_text="IP address",
) )
host = models.ForeignKey( host = models.ForeignKey(
"registrar.Host", "registrar.Host",
on_delete=models.PROTECT, on_delete=models.PROTECT,
related_name="ip", # access this HostIP via the Host as `host.ip` related_name="ip", # access this HostIP via the Host as `host.ip`
help_text="Host to which this IP address belongs", help_text="IP associated with this host",
) )