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

Minor document update with clear images #247

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

srbala
Copy link

@srbala srbala commented Mar 15, 2021

Document contains images not visible to read so, added new images. On step 3, check label change over the time, fix the label

  • Make sure you are opening from a topic/feature/bugfix branch (right side) and not your master branch!
  • Ensure that the pull request title represents the desired changelog entry
  • Please describe what you did
  • Link to relevant issues in GitHub or Jira - Plugin document site https://plugins.jenkins.io/github/
  • Link to relevant pull requests, esp. upstream and downstream changes - N/A
  • Ensure you have provided tests - that demonstrates feature works or fixes the issue - N/A

Copy link

@jimklimov jimklimov left a comment

Choose a reason for hiding this comment

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

Useful update of the docs, especially now that login/pass based stuff does not work :)

@@ -85,7 +85,8 @@ Login and Password to token**
> credentials.

Choose a reason for hiding this comment

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

By trial and error I found that the "Secret text" token, at least for a public github.com account, should contain just the token value ("ghp_Vari0usChars"); the "Test Connection" button helps see if that works. It seems that github knows the user name from that token alone.

I did not uncover what "in corresponding domain" here means in practice, and "Credentials are filtered on changing custom GitHub URL" in help text. My credential ID and description deliberately did not mention neither the account name nor github.com, and it still worked for the default https://api.github.com URL.

This would be nice to clarify in the doc and help, while we are at it.

Copy link
Author

@srbala srbala Jul 31, 2021

Choose a reason for hiding this comment

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

Adding some some text and screen shorts would be nice, I think.

Copy link
Member

@oleg-nenashev oleg-nenashev left a comment

Choose a reason for hiding this comment

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

Would be nice to retain the original image file names. Anyway, it is a nice improvement, thanks!

@srbala
Copy link
Author

srbala commented Aug 15, 2021

Would be nice to retain the original image file names. Anyway, it is a nice improvement, thanks!

@oleg-nenashev Can I replace the old files? OR old name with suffix?

Signed-off-by: Bala Raman <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants