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

fix documentation links #2268

Merged
merged 8 commits into from
Aug 23, 2022
Merged

fix documentation links #2268

merged 8 commits into from
Aug 23, 2022

Conversation

gsnider2195
Copy link
Contributor

@gsnider2195 gsnider2195 commented Aug 19, 2022

Closes: #DNE

What's Changed

  • Fix links in documentation

TODO

  • Explanation of Change(s)
  • n/a Attached Screenshots, Payload Example
  • n/a Unit, Integration Tests
  • n/a Documentation Updates (when adding/changing features)
  • n/a Example Plugin Updates (when adding/changing features)
  • n/a Outline Remaining Work, Constraints from Design

Copy link
Contributor

@glennmatthews glennmatthews left a comment

Choose a reason for hiding this comment

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

Assuming you've validated that the updated links are valid (why doesn't mkdocs/markdownlint do this for us??) these all look like good fixes to me. :-)

@@ -291,22 +291,22 @@ This will run the following management commands with default settings, in order:
!!! note
Commands listed here that are not covered in this document here are Django built-in commands.

`--no-clearsessions`
Copy link
Contributor

Choose a reason for hiding this comment

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

These spaces were purposefully here. Without the double-spaces, the text below will appear on the same line.

Copy link
Contributor

Choose a reason for hiding this comment

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

image

Copy link
Contributor

Choose a reason for hiding this comment

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

Good catch. See also microsoft/vscode#1679 - personally I am not a fan of trailing whitespace for formatting as it's non-obvious, as we see here. Can we use literal <br> instead?

Copy link
Contributor

Choose a reason for hiding this comment

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

I don't like the idea of putting literal <br/> seeing as long as we maintain proper whitespace it should be fine.

Copy link
Contributor

@smk4664 smk4664 Aug 22, 2022

Choose a reason for hiding this comment

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

I too don't like the literal <br/> and it will break one of the Markdownlint checks: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md033

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Can we use 2 line breaks instead of trailing whitespace or <br>

Copy link
Contributor

@glennmatthews glennmatthews left a comment

Choose a reason for hiding this comment

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

Looks like mkdocs by design only validates file relative links (../../models/extras/status.md) and not directory relative links (../../../models/extras/status/), so let's have these use the validated style.

nautobot/docs/administration/nautobot-server.md Outdated Show resolved Hide resolved
nautobot/docs/administration/nautobot-server.md Outdated Show resolved Hide resolved
nautobot/docs/models/circuits/circuit.md Outdated Show resolved Hide resolved
nautobot/docs/models/dcim/cable.md Outdated Show resolved Hide resolved
nautobot/docs/models/dcim/device.md Outdated Show resolved Hide resolved
nautobot/docs/models/virtualization/virtualmachine.md Outdated Show resolved Hide resolved
nautobot/docs/models/virtualization/vminterface.md Outdated Show resolved Hide resolved
nautobot/docs/user-guides/getting-started/ipam.md Outdated Show resolved Hide resolved
nautobot/docs/user-guides/getting-started/platforms.md Outdated Show resolved Hide resolved
nautobot/docs/user-guides/getting-started/tenants.md Outdated Show resolved Hide resolved
@glennmatthews
Copy link
Contributor

#2274 overlaps with this but I didn't fix the status links that this PR includes.

@gsnider2195 gsnider2195 merged commit 6f5df5a into develop Aug 23, 2022
@gsnider2195 gsnider2195 deleted the gas-fix-docs-links branch August 23, 2022 18:45
gsnider2195 added a commit that referenced this pull request Aug 23, 2022
gsnider2195 added a commit that referenced this pull request Aug 26, 2022
Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>
gsnider2195 added a commit that referenced this pull request Aug 26, 2022
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.

None yet

4 participants