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: Update instructions for raising support issues #307

Merged
merged 2 commits into from
Jan 3, 2025

Conversation

AboveHero
Copy link
Contributor

  • Removed old image assets
  • Added new image asset
  • Updated documentation
  • General semantic changes

This PR will bring the documentation up to date with the new Service Center portal design, and also includes some general semantic improvements.

@AboveHero
Copy link
Contributor Author

I had no other way of getting the formatting to render correctly than to abuse the formatting of the documentation. I have spent hours trying to get this right, but my conclusion is that the markdownlinter simply does not account for the mkdocs rendering engine. When formatting these unordered lists in a traditional markdown format they render as flat rather than nested unordered lists.

$ tox -e markdownlint 
markdownlint: commands[0]> pymarkdown -c .pymarkdown.json scan -r docs
docs/howto/support/raise-issues.md:46:5: MD007: Unordered list indentation [Expected: 2, Actual=4] (ul-indent)
docs/howto/support/raise-issues.md:47:5: MD007: Unordered list indentation [Expected: 2, Actual=4] (ul-indent)
docs/howto/support/raise-issues.md:50:5: MD007: Unordered list indentation [Expected: 2, Actual=4] (ul-indent)
docs/howto/support/raise-issues.md:51:5: MD007: Unordered list indentation [Expected: 2, Actual=4] (ul-indent)
docs/howto/support/raise-issues.md:63:5: MD007: Unordered list indentation [Expected: 2, Actual=4] (ul-indent)
docs/howto/support/raise-issues.md:72:5: MD007: Unordered list indentation [Expected: 2, Actual=4] (ul-indent)
docs/howto/support/raise-issues.md:76:5: MD007: Unordered list indentation [Expected: 2, Actual=4] (ul-indent)
docs/howto/support/raise-issues.md:77:5: MD007: Unordered list indentation [Expected: 2, Actual=4] (ul-indent)
docs/howto/support/raise-issues.md:104:6: MD007: Unordered list indentation [Expected: 4, Actual=6] (ul-indent)
docs/howto/support/raise-issues.md:122:6: MD007: Unordered list indentation [Expected: 4, Actual=6] (ul-indent)
docs/howto/support/raise-issues.md:123:6: MD007: Unordered list indentation [Expected: 4, Actual=6] (ul-indent)

@fghaas
Copy link
Contributor

fghaas commented Dec 6, 2024

Well it's rather simple: if the linter is wrong, we'll just override the linter. :) I've pushed a fixup commit to that effect that you can subsequently squash into yours. I have a few minor notes on the substance of the PR too, I'll get to that in a bit.

Copy link
Contributor

@fghaas fghaas left a comment

Choose a reason for hiding this comment

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

Thanks! This looks pretty good; sorry for the slow review. I have a few suggestions. Please see the inline comments.

@AboveHero AboveHero force-pushed the feat/raise-issues branch 2 times, most recently from 7935df2 to bc66ad1 Compare December 27, 2024 12:54
@AboveHero
Copy link
Contributor Author

Oops. I accidentally force pushed without comitting...

fghaas and others added 2 commits January 3, 2025 11:20
The ul-indent check in the Markdown linter is overzealous, so disable
it.
Bring the documentation up to date with the new Service Center portal
design:

- Remove old image assets
- Add new image asset
- Update documentation
- General semantic changes
@fghaas fghaas force-pushed the feat/raise-issues branch from bc66ad1 to de8fff3 Compare January 3, 2025 10:25
@fghaas fghaas changed the title feat: raise-issue fix: Update instructions for raising support issues Jan 3, 2025
Copy link
Contributor

@fghaas fghaas left a comment

Choose a reason for hiding this comment

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

Fixed the last minor outstanding changes, rebased on current main, and brought back the fix to the linter configuration that was accidentally dropped in the force-push. This looks good to me now; I'll go ahead and merge/publish. Thank you!

@fghaas fghaas merged commit de8fff3 into citynetwork:main Jan 3, 2025
3 checks passed
@AboveHero AboveHero deleted the feat/raise-issues branch January 3, 2025 15:42
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.

2 participants