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

MarkdownLint should be run on our docs #1385

Closed
smk4664 opened this issue Feb 17, 2022 · 4 comments · Fixed by #1635
Closed

MarkdownLint should be run on our docs #1385

smk4664 opened this issue Feb 17, 2022 · 4 comments · Fixed by #1635
Assignees
@glennmatthews
Labels
type: housekeeping Changes to the application which do not directly impact the end user

Comments

@smk4664
Copy link
Contributor

smk4664 commented Feb 17, 2022

Proposed Changes

Enable MarkdownLint on our code scanning.

Justification

There was an error in the Markdown that caused the sidebar to not work properly on ReadtheDocs. This could/should have been caught by MarkdownLint.
@smk4664
Copy link
Contributor Author

smk4664 commented Feb 17, 2022

I wouldn't mind picking up this issue.

@bryanculver bryanculver added the type: housekeeping Changes to the application which do not directly impact the end user label Feb 17, 2022
@smk4664
Copy link
Contributor Author

smk4664 commented Mar 22, 2022

I haven't forgotten about this issue, just have to update a lot of docs in order to make this change.

@glennmatthews glennmatthews mentioned this issue Mar 30, 2022
Merged
@glennmatthews
Copy link
Contributor

#1557 did a bunch of cleanup to get our docs passing markdownlint at a snapshot in time; next thing that'll be needed is to add markdownlint to invoke tests and to the CI action(s) so that we don't regress in this area.

@glennmatthews glennmatthews mentioned this issue Apr 12, 2022
Merged
2 tasks
@glennmatthews glennmatthews linked a pull request Apr 12, 2022 that will close this issue
Add markdownlint #1635
Merged
2 tasks
@glennmatthews
Copy link
Contributor

Added in next (1.3.0) by #1635.

glennmatthews added a commit that referenced this issue Apr 15, 2022
@glennmatthews
Add release-note for #1385
7ecaf1c
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 15, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@glennmatthews glennmatthews

Labels
type: housekeeping Changes to the application which do not directly impact the end user
Projects
No open projects
Nautobot Core ⚙️
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add markdownlint nautobot/nautobot
3 participants
@bryanculver @glennmatthews @smk4664