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

docs: Use backticks when referencing custom command annotations, fixes #5820 #5927

Conversation

GuySartorelli
Copy link
Collaborator

The Issue

Most annotations are references using quotes, except the newest one where I was told to use backticks.
They should all use backticks - it looks silly with one being rendered differently.

How This PR Solves The Issue

Use backticks when referencing annotations for custom commands in the docs.
Remove annotations from the spelling words list, since anything in backticks is ignored for spelling checks.

Manual Testing Instructions

Take a look at custom commands page in the docs.

Automated Testing Overview

N/A

Related Issue Link(s)

Release/Deployment Notes

N/A

@GuySartorelli
Copy link
Collaborator Author

I'm surprised the buildkite CI is running on this - is there a way to tell buildkite to ignore PRs with a docs: prefix?

@GuySartorelli
Copy link
Collaborator Author

Looks like we could avoid running buildkite on docs PRs using the "Filter builds using a conditional" setting. I'd be happy to set that up if you like, looks like I have enough permissions to set that.

@rfay
Copy link
Member

rfay commented Mar 4, 2024

Thanks for this! Improvement in how the buildkite run works would be welcome. You'll see they already shortcut the tests (but have to wait to run to do it).

image

Copy link
Member

@rfay rfay left a comment

Choose a reason for hiding this comment

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

Thanks for this!

@rfay rfay merged commit cd798dc into ddev:master Mar 4, 2024
14 checks passed
@GuySartorelli GuySartorelli deleted the 20240304_GuySartorelli_backticks-for-annotations branch March 5, 2024 05:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants