open-telemetry
[Outreachy Meta] Read this issue if you are participating in the outreachy contribution period December 2024
[!IMPORTANT]
- Oct. 29, 2024 4pm UTC is the deadline for applicants to record contributions and create a final application.
- The deadline to register for the project via the outreachy platform has been extended until Oct 23 7am UTC. If you want to participate, please make sure that you record at least one contribution to the "OpenTelemetry Registry" project.
- Make sure that you work on your assigned tasks, and that you provide your timeline until Oct 25th. Use the remaining days until the deadline to finalize your application independently.
Hello everyone!
Thank you for participating in Outreachy and being interested in contributing to the OpenTelemetry Project! This issue will help you during the contribution phase, by providing some instructions on how to get started and it also will list contribution period tasks you can pick up, complete and then submit!
Getting Help
If you have any questions, any issues, or just want to chat with mentors and participants, register with CNCF Slack and join the channels #otel-comms and #otel-registry-uxui-mentorship-outreachy-december-2024.
Getting Started
As a good starting point to familiarize yourself with our project, we recommend you dive into our contribution guidelines, especially the section around setting up a dev environment will be helpful, since you will need a local development environment to contribute to our project successfully.
Since those guidelines are made for new comers, do not hesitate to ask any questions or call out what is unclear!
When you have your local setup up and running I recommend that you start playing around with it by introductions minor changes and seeing how they affect the website. It’s all build using Hugo (https://gohugo.io/) and we use the docsy theme (https://www.docsy.dev/)
As you know for the project itself we will look into the UI/UX of the registry which you will find when you click on “Ecosystem” at the top and then registry. Explore it, try to find something with it, take a look if you understand how it works.
Contribution Period Tasks
When you have set up your local development as outlined above and have yourself familiarized with our website, and the registry, you can start with the small contribution period tasks from the list below:
- after going to the
Getting Startedabove, setting up the development environment and familiarizing yourself with the website & registry, apply a minor change to your local copy of the registry (http://localhost:1313/ecosystem/registry/), take a screenshot, visually highlight the change you applied on the image and attach the image as a comment to this issue. - review the Registry and create a short usability report using the following form: https://forms.gle/vA3vSQv5vcsmtdzQ9. Note: if you'd like to redo your report or if we ask you to apply changes to your report, just fill out the form another time.
After you have completed both steps above, we will ask you to implement one or two improvements for the registry UI and submit a pull request for it. ~~Although we aim for it, we may not merge the PR during the contribution period, which will be for reasons outside of your control. In any case we will confirm with a comment, when you have completed the task successfully.~~ We will not merge any of the PRs provided until the end of the application phase, this way we ensure that every participant can build on top of the same state of the registry and nobody needs to re-do their work because of potential conflicts. We will confirm via a comment that you have completed the task. After the application phase we will aim to merge PRs, however we will not be able to merge all of them for reasons outside of your control. This will have no impact on you completing this task successfully.
With your registry UI improvements done you have completed the mandatory part of the application phase. If time and your bandwidth allows it, you can now look into outreachy/ux issues and contribute to those. Comment on a issue you'd like to work on and we will acknowledge your interest. Please pick only one issue at a time!
Here are a few requirements and recommendations for the implementations:
- Make yourself familiar with Bootstrap and Docsy, since our current design is building on top of this framework and theme. Your change should not introduce any other major design framework dependencies. If you want to use an additonal external dependency, please ask on slack upfront if what you plan to use is acceptable.
- As of today the registry is build within hugo, so it is a static website without a proper backend and database. This is a limitation we are not going to change in this project, so do not try to change that.
- Provide your pull request early: there is no harm to submit your unfinished work as a draft PR. As a new comer to any opensource project it is advicable to ask for feedback early, so you are not spending a lot of time in implementation and will then be asked to change major parts once again
- After you have provided your pull request there will be a set of CI checks running and some of them will very likely fail. Do not worry about them until told otherwise. Maintainers will help you to get them fixes as needed.
Registry Source Code
The OpenTelemetry Registry consists of multiple components that you will need to take a look into to modify it:
- The _index page, which will cause hugo to render the page at
/ecosystem/registry - search-form.html shortcode which is responsible for rendering the registry formular
- registry partials a set of templates used for rendering entries and "quick install" instructions
- registry.scss for the stylesheets
- registrySearch.js powers the search engine
- data/registry all the entries in the registry
- registry.json.json for populating the search index
Thank you once again for contributing to OpenTelemetry!
@svrnm I edited a line on the registry page, and I’ve completed the usability report form.
I had my name inputed as an author for the cloud foundry article thereby validating usability report form.
I have edited the Envoy Proxy title and also filled out the usability report form.
Hello. I have edited index page and search form. Looking forward to the next part.
Hello, I edited the Title and the Language & Type filter. I have also completed the usability report.
Hy @svrnm, I've been able to successfully set up the codebase and make some edits. Moving to the form now
Hi, @svrnm It's Rebecca. I have set up the dev env on my local machine using WSL for Ubuntu. I changed the background color and color of the "Search 832 entries" to blue and white as seen in the image below. I also added "Our" to the text.
I have filled out the usability form.
Hello @svrnm, I am Yashi. I have been able to set up dev environment on my local and made some changes -
Have changed the background color of cloud foundry card and added black borders for the right section.
I have also filled out the usability form.
Thanks
Hello @svrnm I've been able to setup my local environment successfully also I added my name here .. Moving to the form now
Hi @svrnm , my name is Oluchi Gift. I have been able to set up my dev environment. And i changed the title to Registry (Edited by Oluchi) and the subtitle to "This helps to find libraries, plugins, integrations and other useful tools for using and extending opentelemetry
Hello @svrnm I was able to set up my local environment and also made some changes underlines in red. I have also gone ahead to fill out the usability report.
Hi @svrnm . I was able to set up my local environment and make edits to the registry. I have also filled out the usability report.
Hi @svrnm, I have finished setting up the project locally. I have also made some edits to the registry page and filled out the usability form.
Hi @svrnm, I have finished setting up the project locally and I have made some changes to the registry.
Hi @svrnm i was able to make a small change to the registry
as highlighted below. Now moving on to the usability report
@ladyami while I appreciate your effort, please review the instructions in the issue description above, I ask people to show a screenshot of them successfully setting up a dev environment, and also the survey (that you filled out) is not asking for a visual design suggestion yet.
Good day, I modified the form input placeholder to " Type to search the registry.." and the input field label.
**I am working from GitHub codespaces hence my project is not exactly reflecting "localhost:1313..." please let me know if this is not allowed.
@ladyami while I appreciate your effort, please review the instructions in the issue description above, I ask people to show a screenshot of them successfully setting up a dev environment, and also the survey (that you filled out) is not asking for a visual design suggestion yet.
I am sorry I did the design based on what I read about the project in outreachy website here is my setup I set it up on gitpod
@svrnm Good day, I have successfully set up my local dev environment and was able to edit the index page and search button (from Submit to Search) and I also included the link to Traefik hub API management. I have also filled the usuability form.
Good day @svrnm, I have successfully set up the local dev environment and edited the registry page. I have also filled the usability form.
~~Thank you all for participating, as announced I closed the project for new contributors. I will work with those of you who still have open tasks to work on.~~
[!IMPORTANT] The deadline to register for the project via the outreachy platform has been extended until Oct 23 7am UTC. If you want to participate, please make sure that you record at least one contribution to the "OpenTelemetry Registry" project.