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

Add a sample user profile #46

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

prudhvigodithi
Copy link
Member

@prudhvigodithi prudhvigodithi commented Aug 26, 2024

Description

Coming from the conversation part of this issue opensearch-project/opensearch-metrics#61, onboard user profiles.

We can keep adding more fields and remove few fields based on the user choice.

Issues Resolved

Part of opensearch-project/opensearch-metrics#61 and opensearch-project/opensearch-metrics#51

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@prudhvigodithi
Copy link
Member Author

Adding @dblock @krisfreedain @getsaurabh02 @peterzhuamazon to please take a look at this PR, once agreed I will change to ready for review.

@prudhvigodithi
Copy link
Member Author

Following up here @dblock @krisfreedain please add your thoughts on this user profiles format.
Thank you

@prudhvigodithi
Copy link
Member Author

  • Added the user profile scheme to ensure the user profiles (the keys) are consistent.
  • Added the following as required fields for a user profile.
        "required": [
            "name",
            "github_username",
            "opensearch_slack_username",
            "company"
        ],
    
  • The profile_image and location are not mandatory fields (I'm open for discussion).
  • Added a GitHub CI workflow that can run on a profile and validate against the schema, will throw an error if the profile is not matching the schema, here are some sample validation runs https://github.com/prudhvigodithi/community/actions.

Thank you
@krisfreedain @dblock @dblock

@prudhvigodithi
Copy link
Member Author

I have noticed the project website (https://github.com/opensearch-project/project-website/tree/main/_community_members) uses personas, I have added the same for user profiles. I have sampled data for prudhvigodithi with the persona of author, getsaurabh02 with the persona of conference_speaker, and CMDWillYang with the persona of OSCI. With this project, the website should be able to utilize these user profiles. Please note that the personas field is optional for user profiles.

Added social_media_profiles which can have the user ID's of different social media platforms. For now the schema is restricted (with additionalProperties set to false) to linkedin_id and twitter_id. We can keep expanding as we go.

Thank you
@getsaurabh02

@dblock
Copy link
Member

dblock commented Sep 11, 2024

This looks ok to me, no real concerns. For images, maybe worth calling them all thumbnail or something like that.

@prudhvigodithi
Copy link
Member Author

Thanks @dblock you mean the folder assets/profile-images/ to change to thumbnails?

Signed-off-by: Prudhvi Godithi <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 👀 In review
Development

Successfully merging this pull request may close these issues.

2 participants