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

[outreachy] converted the add your project to the registry into a button #5398

Closed
wants to merge 4 commits into from

Conversation

Isioma20
Copy link

For the second task given of suggesting a prototype design for an actual "add to the registry" page,
I first thought to use a form but here are some reasons why I don't think it is feasible

TECHNICAL FEASIBILITY

The site doesn’t currently have a backend hence it cannot store data collected through a form, ⁠and if we were going to try to create a Pull Request directly from the form submission, the GitHub API doesn’t allow a seamless way to do that.

WORKLOAD

Updating the registry would require someone on the Open Telemetry team to make each individual submission and entry into the data file/data/registry directory

FEEDBACK

It is easier for maintainers to give feedback to contributors via Pull Requests when there is any questions regarding the input than to individually reach out when there are issues with the template entries.
After ideating on different add flows,
I’ve concluded that the current page outlining the process to add projects to the Open telemetry registry is okay and fits to the current style of the website. The only modification I could play around with was making it into a modal but it’s not the best experience on mobile and it also doesn’t fit into the overall aesthetic of the website.

@Isioma20 Isioma20 requested a review from a team as a code owner October 13, 2024 00:05
Copy link

linux-foundation-easycla bot commented Oct 13, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

@svrnm svrnm changed the title converted the add your project to the registry into a button [outreachy] converted the add your project to the registry into a button Oct 14, 2024
@svrnm svrnm added the outreachy Issues for Outreachy Participants label Oct 14, 2024
@svrnm
Copy link
Member

svrnm commented Oct 14, 2024

Thank you for taking a look into the feasibility of adding a project, there are two alterntive options that still would be valuable:

  • After filling out the form the user is presendet with a YML file to copy and instructions where to put it locally
  • Although there is no pull request API, there is a capability to prefill a new file in the web editor, i.e. https://github.com/open-telemetry/opentelemetry.io/new/main?filename=data/registry/test.yml&value=title:+My+Test%0Adescription:+my+test+description

For the button itself, can you take a look how to make it more appealing and integrated into the UI.

@Isioma20
Copy link
Author

Thank you for the feedback @svrnm . I'm currently working on the first item. For the button itself, I'd like to know what can be done to make it more appealing and integrated to the UI.

@svrnm
Copy link
Member

svrnm commented Oct 22, 2024

@Isioma20 please make sure that you register with the outreachy platform after that I will provide a review

@Isioma20
Copy link
Author

Thank you @svrnm. I have registered with the outreachy platform. looking forward to the review

@svrnm
Copy link
Member

svrnm commented Oct 23, 2024

Thank you for the feedback @svrnm . I'm currently working on the first item.

Great, make sure to share results early, or ask questions if you run into any issues

For the button itself, I'd like to know what can be done to make it more appealing and integrated to the UI.

I phrased this as a question, because I would like to hear some suggestions from you. You can take inspiration from other places where people can click an "new item" or "add X" button. I can make some suggestions myself if you need me to, but think about it for a little bit

@svrnm
Copy link
Member

svrnm commented Oct 25, 2024

hey @Isioma20 , giving you a headsup that today is the last day I am able to help you here and make progress with this PR, please let me know if/how I can help you.

@Isioma20
Copy link
Author

Hi @svrnm. Thank you. I'll update this pr before end of day today. I'd also like to inquire if we can continue to work after the application phase has closed

@Isioma20
Copy link
Author

Hi @svrnm. I have edited the add your project button but still reviewing the UI. I have added an add to the registry form using the suggestions that you have previously given me. However, the vs code option isn't currently working

@Isioma20
Copy link
Author

Isioma20 commented Nov 4, 2024

Hi @svrnm. I'd still love any feedback on this Pull request. Thank you!

@svrnm svrnm added the registry label Nov 4, 2024
@svrnm
Copy link
Member

svrnm commented Dec 11, 2024

thanks for working on this during the outreachy application phase. I will close this PR for now, since we currently do not have the capacity to maintain this feature in the website.

@svrnm svrnm closed this Dec 11, 2024
@svrnm svrnm removed the outreachy Issues for Outreachy Participants label Dec 11, 2024
@Isioma20
Copy link
Author

Understood!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants