Skip to content

Add a popup warning about github access after login#130

Merged
nerdalert merged 1 commit intoinstructlab:mainfrom
vishnoianil:popover-warning
Aug 27, 2024
Merged

Add a popup warning about github access after login#130
nerdalert merged 1 commit intoinstructlab:mainfrom
vishnoianil:popover-warning

Conversation

@vishnoianil
Copy link
Member

Warning will only pop up once user login.
Currently we don't store any user related state,
so the warning will popup everytime user session
renews (or user does explict logout/login).

In the "Dev" mode, this warning won't popup to
avoid annoying dev's with the contact popup of warning while they do the local dev and login/logout upteen number of times in a day.

Fixes #82

@vishnoianil
Copy link
Member Author

Screenshot 2024-08-22 at 11 42 32 PM

@Misjohns Can you please review the text that I wrote in the warning popup. Let me know if you have any suggestion about the text and in general about the popup warning itself.

@edonehoo
Copy link

edonehoo commented Aug 26, 2024

@vishnoianil hi! I'm a content designer who works with Missy. Based off of our product design system, PatternFly, there are a few wording and formatting changes that I would advise.

Let me know what you think about this rewrite:


GitHub Access Permissions

To allow InstructLab UI to manage your taxonomy submissions, you must grant read and write permissions to your GitHub account. InstructLab UI will use your account to:

  • Pull PRs from the upstream InstructLab Taxonomy repo that you’ve opened to contribute skill and knowledge.
  • Fork the InstructLab Taxonomy repo to your GitHub account and create PRs from this fork, which can merge into the upstream Taxonomy repo.
  • Fork the taxonomy-knowledge-docs repo to your GitHub account and upload knowledge-related documents from your account.

These permissions do not enable InstructLab UI to access your GitHub password.

To provide InstructLab UI with the permissions necessary for managing your taxonomy submissions, select accept. If you do not wish to grant these permissions, select deny to sign out of InstructLab UI.

@vishnoianil
Copy link
Member Author

GitHub Access Permissions

To allow InstructLab UI to manage your taxonomy submissions, you must grant read and write permissions to your GitHub account. InstructLab UI will use your account to:

  • Pull PRs from the upstream InstructLab Taxonomy repo that you’ve opened to contribute skill and knowledge.
  • Fork the InstructLab Taxonomy repo to your GitHub account and create PRs from this fork, which can merge into the upstream Taxonomy repo.
  • Fork the taxonomy-knowledge-docs repo to your GitHub account and upload knowledge-related documents from your account.

These permissions do not enable InstructLab UI to access your GitHub password.

To provide InstructLab UI with the permissions necessary for managing your taxonomy submissions, select accept. If you do not wish to grant these permissions, select deny to sign out of InstructLab UI.

@edonehoo This looks great!, really appreciate the review. I was also thinking of adding the url to the "taxonomy" repo and "taxonomy-knowledge-docs" repo, so that user know what repo it is referring to. These links won't be visible in the warning popup, so i assume the change should be fine, but in case not, please let me know.

@vishnoianil
Copy link
Member Author

GitHub Access Permissions
To allow InstructLab UI to manage your taxonomy submissions, you must grant read and write permissions to your GitHub account. InstructLab UI will use your account to:

  • Pull PRs from the upstream InstructLab Taxonomy repo that you’ve opened to contribute skill and knowledge.
  • Fork the InstructLab Taxonomy repo to your GitHub account and create PRs from this fork, which can merge into the upstream Taxonomy repo.
  • Fork the taxonomy-knowledge-docs repo to your GitHub account and upload knowledge-related documents from your account.

These permissions do not enable InstructLab UI to access your GitHub password.
To provide InstructLab UI with the permissions necessary for managing your taxonomy submissions, select accept. If you do not wish to grant these permissions, select deny to sign out of InstructLab UI.

@edonehoo This looks great!, really appreciate the review. I was also thinking of adding the url to the "taxonomy" repo and "taxonomy-knowledge-docs" repo, so that user know what repo it is referring to. These links won't be visible in the warning popup, so i assume the change should be fine, but in case not, please let me know.

This is how it looks now. Please let me know if it requires any other changes.

Screenshot 2024-08-26 at 11 13 36 PM

Warning will only pop up once user login.
Currently we don't store any user related state,
so the warning will popup everytime user session
renews (or user does explict logout/login).

In the "Dev" mode, this warning won't popup to
avoid annoying dev's with the contact popup of warning
while they do the local dev and login/logout upteen
number of times in a day.

Signed-off-by: Anil Vishnoi <vishnoianil@gmail.com>
@edonehoo
Copy link

edonehoo commented Aug 27, 2024

@vishnoianil I think links are a great idea! I think it would be most clear to include the entire phrase in the link text, so that users can better understand that the links lead to GH. So InstructLab Taxonomy repo and taxonomy-knowledge-docs repo.

And a couple of small final adjustments that I noticed:

  • in the first bullet point, change "contribute skill" to plural "contribute skills".
  • Add an extra line break at the end of the modal, between the two sentences beginning with "These permissions do not enable InstructLab...." and "To provide InstructLab UI with the permissions necessary..."

Otherwise, this is looking great to me!

@vishnoianil
Copy link
Member Author

@vishnoianil I think links are a great idea! I think it would be most clear to include the entire phrase in the link text, so that users can better understand that the links lead to GH. So InstructLab Taxonomy repo and taxonomy-knowledge-docs repo.

And a couple of small final adjustments that I noticed:

  • in the first bullet point, change "contribute skill" to plural "contribute skills".
  • Add an extra line break at the end of the modal, between the two sentences beginning with "These permissions do not enable InstructLab...." and "To provide InstructLab UI with the permissions necessary..."

Otherwise, this is looking great to me!

Addressed through another PR #133. Here is the latest snapshot.

Screenshot 2024-08-27 at 9 03 26 AM

@Misjohns
Copy link
Collaborator

The second text line of the bullets should align with the first line text instead of with the bullet.
image

@vishnoianil
Copy link
Member Author

The second text line of the bullets should align with the first line text instead of with the bullet. image

I will take care of that in next PR, thanks for pointing that out @Misjohns

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.

Show warning pop-up when user login

4 participants