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(datasource/custom): rewrite debugging section #30250

Merged
merged 3 commits into from
Jul 22, 2024

Conversation

HonkingGoose
Copy link
Collaborator

Changes

  • Write short sentences
  • Use common words
  • Use ordered list
  • Add headings
  • Use active voice and present tense
  • Emphasize the key difference in one sentence
  • Add a good title to the JSON codeblock
  • Link to the docs for the configuration options
  • Explain who the information is for with the If you ... then do ... style sentences

Context

Rewrite the text that @secustor added with:

Documentation (please check one with an [x])

  • I have updated the documentation, or
  • No documentation update is required

How I've tested my work (please select one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added/modified unit tests, or
  • No unit tests but ran on a real repository, or
  • Both unit tests + ran on a real repository

lib/modules/datasource/custom/readme.md Outdated Show resolved Hide resolved
lib/modules/datasource/custom/readme.md Outdated Show resolved Hide resolved
@HonkingGoose HonkingGoose requested a review from secustor July 19, 2024 10:29
Copy link
Collaborator

@secustor secustor 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 rewriting the docs. I have added the relative links and a fix for the linting issue.

lib/modules/datasource/custom/readme.md Outdated Show resolved Hide resolved
lib/modules/datasource/custom/readme.md Outdated Show resolved Hide resolved
lib/modules/datasource/custom/readme.md Outdated Show resolved Hide resolved
HonkingGoose and others added 2 commits July 20, 2024 13:55
Co-authored-by: Sebastian Poxhofer <[email protected]>
Co-authored-by: Sebastian Poxhofer <[email protected]>
@rarkins rarkins added this pull request to the merge queue Jul 22, 2024
Merged via the queue into renovatebot:main with commit 94e333f Jul 22, 2024
38 checks passed
@HonkingGoose HonkingGoose deleted the docs/30241-follow-up branch July 22, 2024 14:14
@renovate-release
Copy link
Collaborator

🎉 This issue has been resolved in version 37.438.5 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 22, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants