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.

Sign up for GitHub

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

Jump to bottom

Provide Customization for Help Link in UI to Proper Documentation Page #4052

Closed
bryanculver opened this issue Jul 5, 2023 · 1 comment · Fixed by #4059
Closed

Provide Customization for Help Link in UI to Proper Documentation Page #4052

bryanculver opened this issue Jul 5, 2023 · 1 comment · Fixed by #4059
Assignees
@glennmatthews
Labels
type: documentation Improvements or additions to documentation
Milestone
v2.0.0

Comments

@bryanculver
Copy link
Member

bryanculver commented Jul 5, 2023 •
edited

Not having a consistent static file path for all "models" documentation makes it a lot harder to have a link from the UI to the corresponding documentation, FWIW. (Currently we have this from the (?) button when creating/editing a model, but I could see a strong argument in the future for also adding a link from the list and detail views as well.

Originally posted by @glennmatthews in #4041 (comment)

Thanks for calling this out. We need to come up with a solution to be able to point the help links to any part of the docs structure. One reason is for this case, where I'd much prefer the UX of the docs not be constrained to a technical detail of the web UI. Second, I want help links for other feature areas that aren't directly models, in the future.

Originally posted by @lampwins in #4041 (comment)
@bryanculver bryanculver added the type: documentation Improvements or additions to documentation label Jul 5, 2023
@bryanculver bryanculver added this to the v2.0.0 milestone Jul 5, 2023
@glennmatthews glennmatthews mentioned this issue Jul 5, 2023
Merged
5 tasks
@glennmatthews glennmatthews linked a pull request Jul 5, 2023 that will close this issue
Update model UI help paths in refactored docs, fix markdownlint #4059
Merged
5 tasks
@glennmatthews
Copy link
Contributor

Completed by #4059

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 6, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@glennmatthews glennmatthews

Labels
type: documentation Improvements or additions to documentation
Projects
No open projects
Nautobot Core ⚙️
Archived in project
Milestone
v2.0.0
Development

Successfully merging a pull request may close this issue.

Update model UI help paths in refactored docs, fix markdownlint nautobot/nautobot
2 participants
@bryanculver @glennmatthews