Skip to content

Adds an about section to the Circuit Maintenance Dashboard. - #365

Open
jvanderaa wants to merge 7 commits into
developfrom
233_about_page
Open

Adds an about section to the Circuit Maintenance Dashboard.#365
jvanderaa wants to merge 7 commits into
developfrom
233_about_page

Conversation

@jvanderaa

@jvanderaa jvanderaa commented Dec 12, 2025

Copy link
Copy Markdown
Collaborator

Closes: #233

What's Changed

Adds an About card to the Circuit Maintenance dashboard, built with Nautobot UI
constructs (card / card-header / card-body, the placeholder filter, and <code>
formatting for version values). The card surfaces two derived values, both read from
package metadata (nothing hardcoded):

  • App Version — the installed nautobot-circuit-maintenance version.
  • Circuit Maintenance Parser Version — the installed circuit-maintenance-parser version.

This is useful for verifying which version of the app is deployed and which version of
the parser logic is processing notifications.

develop has been merged in to keep the branch current (Nautobot 3.x / Django 5.2).

Screenshots

Light Dark
About card - light About card - dark

To Do

  • Explanation of Change(s)
  • Added change log fragment(s) (for more information see the documentation)
  • Attached Screenshots, Payload Example
  • Unit, Integration Tests
  • Documentation Updates (when adding/changing features)
  • Outline Remaining Work, Constraints from Design

@github-actions

github-actions Bot commented Dec 12, 2025

Copy link
Copy Markdown

Coverage report

Click to see where and how coverage changed

FileStatementsMissingCoverageCoverage
(new stmts)
Lines missing
  nautobot_circuit_maintenance
  views.py
Project Total  

This report was generated by python-coverage-comment-action

</div>
<div class="card">
<div class="container">
<h3 class="text-start">About</h3>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be more aesthetic to do a div class="card-header" in place of the h3?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image If we do the card-header then we should probably do it in the rest of the sections too. Thoughts @glennmatthews ?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd be in favor of that, yes. The current styling is very inconsistent with the rest of Nautobot, IMHO.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm good by that. I'll be diving in later today looking for a styling guide or how I can make the dashboard page look more appropriate.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done — I reworked all four dashboard sections (Circuits, Devices, Metrics, and the new About card) to use <div class="card-header"> for consistency with the rest of Nautobot, rather than the old h3 styling. Should be good for another look @glennmatthews.

jvanderaa added 5 commits May 24, 2026 08:33
Refactor the About card to use Nautobot card-body construct and the
placeholder filter, and add the app version alongside the Circuit
Maintenance Parser version (both derived from package metadata).
# Conflicts:
#	nautobot_circuit_maintenance/templates/nautobot_circuit_maintenance/circuit_maintenance_overview.html
Update the About card docs to note it now shows the app version in
addition to the parser version, and add light/dark screenshots.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Provide an About Page to Show Version of Parser

2 participants