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: Add Article on how Swissquote uses Renovate #16809

Merged
merged 21 commits into from Aug 12, 2022
Merged

Conversation

onigoetz
Copy link
Contributor

Changes

As discussed in #16502 and #16484 this PR proposes my Medium Article about Renovate in a new User Stories section.

Context

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 tick 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

@onigoetz onigoetz changed the title Add Article on how Swissquote uses Renovate docs: Add Article on how Swissquote uses Renovate Jul 27, 2022
@onigoetz
Copy link
Contributor Author

Hi @HonkingGoose as discussed in #16502 here is my PR for my Medium article

@HonkingGoose

This comment was marked as resolved.

@onigoetz
Copy link
Contributor Author

Sure, it's done

Copy link
Collaborator

@HonkingGoose HonkingGoose left a comment

Choose a reason for hiding this comment

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

Initial review, mainly focusing on:

  • One sentence per line
  • Typos
  • Capitalization
  • Other small stuff

Edit: Please "batch" all my suggestions into one commit, instead of applying them one-by-one.

GitHub docs, Incorporating feedback in your pull request

docs/usage/user-stories/swissquote.md Outdated Show resolved Hide resolved
docs/usage/user-stories/swissquote.md Outdated Show resolved Hide resolved
docs/usage/user-stories/swissquote.md Outdated Show resolved Hide resolved
docs/usage/user-stories/swissquote.md Outdated Show resolved Hide resolved
docs/usage/user-stories/swissquote.md Outdated Show resolved Hide resolved
docs/usage/user-stories/swissquote.md Outdated Show resolved Hide resolved
docs/usage/user-stories/swissquote.md Outdated Show resolved Hide resolved
docs/usage/user-stories/swissquote.md Outdated Show resolved Hide resolved
docs/usage/user-stories/swissquote.md Outdated Show resolved Hide resolved
docs/usage/user-stories/swissquote.md Outdated Show resolved Hide resolved
onigoetz and others added 7 commits July 27, 2022 16:16
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
onigoetz and others added 2 commits July 27, 2022 16:25
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
@onigoetz
Copy link
Contributor Author

I fixed a few more punctuation issues, should I also make one sentence per line for list items ?

Copy link
Collaborator

@HonkingGoose HonkingGoose left a comment

Choose a reason for hiding this comment

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

Some more things.

docs/usage/user-stories/swissquote.md Outdated Show resolved Hide resolved
docs/usage/user-stories/swissquote.md Outdated Show resolved Hide resolved
docs/usage/user-stories/swissquote.md Outdated Show resolved Hide resolved
docs/usage/user-stories/swissquote.md Outdated Show resolved Hide resolved
docs/usage/user-stories/swissquote.md Outdated Show resolved Hide resolved
docs/usage/user-stories/swissquote.md Show resolved Hide resolved
docs/usage/user-stories/swissquote.md Outdated Show resolved Hide resolved
docs/usage/user-stories/swissquote.md Outdated Show resolved Hide resolved
docs/usage/user-stories/swissquote.md Outdated Show resolved Hide resolved
docs/usage/user-stories/swissquote.md Outdated Show resolved Hide resolved
@HonkingGoose
Copy link
Collaborator

I fixed a few more punctuation issues, should I also make one sentence per line for list items ?

Thank you for fixing some more punctuation problems. 😉

Keep the lists as they are, or we'll have problems with the display of the lists. 😉

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
@onigoetz
Copy link
Contributor Author

Keep the lists as they are, or we'll have problems with the display of the lists. 😉

I think that using two spaces at the start of a line adds the line to the previous list item instead of starting a new one or ending the list

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Copy link
Collaborator

@astellingwerf astellingwerf left a comment

Choose a reason for hiding this comment

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

Nice read!

docs/usage/user-stories/swissquote.md Show resolved Hide resolved
docs/usage/user-stories/swissquote.md Show resolved Hide resolved
docs/usage/user-stories/swissquote.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@HonkingGoose HonkingGoose left a comment

Choose a reason for hiding this comment

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

We can keep the good part "It's not only about the tooling" and drop the mention of Dependabot and Snyk:

  • Remove line which mentions Dependabot and Snyk
  • Copy/paste good part into the next sentence

docs/usage/user-stories/swissquote.md Outdated Show resolved Hide resolved
docs/usage/user-stories/swissquote.md Outdated Show resolved Hide resolved
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Copy link
Collaborator

@HonkingGoose HonkingGoose left a comment

Choose a reason for hiding this comment

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

Nearly there! 😄

docs/usage/user-stories/swissquote.md Outdated Show resolved Hide resolved
docs/usage/user-stories/swissquote.md Outdated Show resolved Hide resolved
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Copy link
Collaborator

@HonkingGoose HonkingGoose left a comment

Choose a reason for hiding this comment

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

Some small things to fix, and then we're good to merge for real. I don't think there's any point in me reviewing it over and over. It's time to get merging soon! 😄

docs/usage/user-stories/swissquote.md Outdated Show resolved Hide resolved
docs/usage/user-stories/swissquote.md Outdated Show resolved Hide resolved
docs/usage/user-stories/swissquote.md Outdated Show resolved Hide resolved
docs/usage/user-stories/swissquote.md Outdated Show resolved Hide resolved
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Copy link
Collaborator

@HonkingGoose HonkingGoose left a comment

Choose a reason for hiding this comment

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

I'm done reviewing this. 😉 I think this is good to merge now. 🥳

@viceice viceice requested a review from rarkins August 10, 2022 07:12
@onigoetz
Copy link
Contributor Author

awesome, thanks a lot for all the proposed improvements @HonkingGoose

@HonkingGoose
Copy link
Collaborator

HonkingGoose commented Aug 10, 2022

awesome, thanks a lot for all the proposed improvements @HonkingGoose

@onigoetz Feel free to take my improvements and put them in your article on Medium. 😉

@rarkins
Copy link
Collaborator

rarkins commented Aug 12, 2022

We can ignore the coverage false positive.

@HonkingGoose do you think we should add links into this article as part of this PR, or afterwards?

@HonkingGoose
Copy link
Collaborator

@HonkingGoose do you think we should add links into this article as part of this PR, or afterwards?

Let's do it afterwards. I don't want to hold up this PR any longer. I'll create a new issue to track this work.

@rarkins rarkins merged commit 19c4334 into renovatebot:main Aug 12, 2022
@renovate-release
Copy link
Collaborator

🎉 This PR is included in version 32.158.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 12, 2022
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.

None yet

5 participants