Clarify migration actions and results in the UI

Open
  • Is something wrong?
#84 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
52/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
python
Domain
documentation, frontend

Research direction

Start by locating the migration pages and the relevant migration guide sections; the issue does not name their files or tests. Review how the listed migration actions and results are presented, then update the brief guidance and guide where needed. Done means users can understand the permission changes, readiness and next steps, Repoint’s scope, and the distinction between Verify’s report and Job completion.

Written by the indexing model from the issue text.

Description

app: scripts complexity: low status: backlog type: feature
Plugin Version

v0.0.1

Proposed functionality

Improve the brief guidance on the migration pages and link to the relevant sections of the migration guide:

  • Explain before inventory that Data Source Projects need a subdirectory, such as scripts/, and that scripts at the source root block staging.
  • Explain which Object Permissions cutover disables, including mixed permissions, which grants are transferred, and which need manual recreation.
  • Clarify revision statuses, Project readiness and the next steps.
  • Explain that Repoint references updates supported Event Rules, permissions and Job history, and recreates eligible captured runs. It does not move files in the source repository.
  • Display Verify’s report result separately from the Job’s completion status. Explain what it checks and that it does not run Scripts or verify stored source files.

Keep detailed explanations in the guide and update the relevant sections where needed.

Use case

Community testing raised questions about permission changes, Project readiness and how to interpret migration results.

The guide already covers much of this. Short explanations beside the relevant actions would help users understand what will change, what needs attention and what to do next.

External dependencies

None expected.

Dominant language
Python
Stars
8
Forks
0
Avg merge
9h 56m
Merged PRs (30d)
29

Getting set up

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.

More from netbox-community/netbox-scripts

All issues in netbox-community/netbox-scripts

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.