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

Add new model checklist to the docs #5189

Closed
64 tasks
gsnider2195 opened this issue Jan 29, 2024 · 6 comments · Fixed by #5555
Closed
64 tasks

Add new model checklist to the docs #5189

gsnider2195 opened this issue Jan 29, 2024 · 6 comments · Fixed by #5555
Assignees
Labels
type: documentation Improvements or additions to documentation type: housekeeping Changes to the application which do not directly impact the end user

Comments

@gsnider2195
Copy link
Contributor

gsnider2195 commented Jan 29, 2024

See the checklist on PR #5137 for an example of the tasks involved. We might want to just add to nautobot/docs/development/apps/api/models/index.md

============ EDIT ===============

  • Explanation of Change(s)
  • Added change log fragment(s) (for more information see the documentation)
  • Attached Screenshots, Payload Example
  • Create $NEWMODEL model
    • Migrations
    • Default statuses (data migration)
    • Serializer
    • List view / Table
    • Create/edit form
    • Create/edit view
    • Bulk edit form
    • Bulk edit view
    • Filterset
    • Filter form
    • Factory
    • Unit tests
    • Documentation
    • Add to homepage
    • ConfigContext
    • extra_features
    • extra_features documentation
    • Update nautobot.apps
    • Add to global search
  • Add FK from $NEWMODEL to $EXISTINGMODEL
    • Migration
    • Model validation (device type must match softwareimage and device)
    • Update querysets (select_related)
    • Serializer
    • Create/edit form
    • Create/edit view
    • Bulk edit form
    • Bulk edit view
    • Device detail view
    • $EXISTINGMODEL detail view
    • Filterset
    • Filter form
    • Factory
    • Unit tests
    • Documentation
  • Add m2m from $NEWMODEL to $EXISTINGMODEL
    • Migration
    • Model validation
    • Update querysets (prefetch_related)
    • Serializer
    • Expose through table in API
      • Serializer
      • Filterset
      • Viewset
      • Tests
    • Create/edit form
    • Create/edit view
    • Bulk edit form
    • Bulk edit view
    • DeviceType detail view
    • $EXISTINGMODEL detail view
    • Filterset
    • Filter form
    • Factory
    • Unit tests
    • Documentation
    • Update nautobot.apps
  • Release overview documentation
  • Example Plugin Updates (when adding/changing features)
  • Outline Remaining Work, Constraints from Design
@gsnider2195 gsnider2195 added type: housekeeping Changes to the application which do not directly impact the end user triage This issue is new and has not been reviewed. and removed triage This issue is new and has not been reviewed. labels Jan 29, 2024
@gsnider2195 gsnider2195 added the type: documentation Improvements or additions to documentation label Feb 8, 2024
@gsnider2195
Copy link
Contributor Author

Missed in #5137: Add new models to the homepage

@gsnider2195
Copy link
Contributor Author

This document should include detailed descriptions of the extras_features decorator options and when to use each of them vs when not to use them.

@gsnider2195
Copy link
Contributor Author

Another thing that was missed, add a foreign key to the model from ConfigContext if the model would be relevant for making configuration decisions. If so, also update ConfigContextQuerySet, ConfigContextFilterSet, ConfigContext forms, edit and detail views and html templates,

@gsnider2195
Copy link
Contributor Author

Add model to the global search

@itdependsnetworks
Copy link
Contributor

Updated initial comment and adjusted to be slightly more generic for ease of access.

@glennmatthews
Copy link
Contributor

Would be terrific to also create an additional PR template specifically for use with new-model PRs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation Improvements or additions to documentation type: housekeeping Changes to the application which do not directly impact the end user
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants