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(faq): explain how to find version number of hosted app #28704

Conversation

HonkingGoose
Copy link
Collaborator

@HonkingGoose HonkingGoose commented Apr 27, 2024

Changes

  • Explain how to find the version number of the hosted app with step by step instructions

Context

Closes #28662

Please check if these steps are correct. I'm in multiple organizations, so I see the organization select screen first. I suppose if you only have Renovate installed as a single user, you will not see the organization select screen, but I can not test this myself.

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

rarkins
rarkins previously approved these changes Apr 27, 2024
@blakeNaccarato
Copy link

blakeNaccarato commented Apr 27, 2024

The guide looks pretty good, I appreciate the guidance for log searching, which wasn't straightforward to me.

There may be a potentially confusing selection for "Select the App", either RENOVATE or FORKING RENOVATE. Should the FAQ clarify this in this particular question? Or even have this particular dialog be clearer in its own description of "Select the app you'd like to log in with" (a separate PR on a whole separate repo I'm sure)? Really, it could probably be left alone, since in context, "forking renovate" probably doesn't "feel" like the right choice for most users.

My sign-in flow looks the same, I'm not sure if the single-user flow differs, probably not by much at least. Also, a possibly quicker alternative would be to select through to the logs via any existing Renovate-authored PR in the desired repo. The link is at the end like, This PR has been generated by Mend Renovate. View repository job log here. But maybe that's not particularly worth mentioning due to its indirectness, even if quicker.

Copy link
Collaborator Author

@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.

Responding to the feedback from @blakeNaccarato.

docs/usage/faq.md Outdated Show resolved Hide resolved
docs/usage/faq.md Outdated Show resolved Hide resolved
docs/usage/faq.md Show resolved Hide resolved
@blakeNaccarato
Copy link

Thanks for your help, and for your responses to my feedback! I appreciate the welcoming contributor experience that you all curate here (even if I'm not actually contributing PRs directly).

This all looks good, and will hopefully reduce noise about hosted app version number confusion in the future!

docs/usage/faq.md Outdated Show resolved Hide resolved
Copy link
Collaborator Author

@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 think we're good to go now.

@rarkins rarkins added this pull request to the merge queue Apr 30, 2024
Merged via the queue into renovatebot:main with commit 09a093d Apr 30, 2024
37 checks passed
@HonkingGoose HonkingGoose deleted the docs/28662-finding-version-number-hosted-app branch April 30, 2024 12:09
@renovate-release
Copy link
Collaborator

🎉 This PR is included in version 37.330.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

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