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

Added missing handler README files; moved deprecated handlers; added … #818

Merged
merged 7 commits into from
May 1, 2024

Conversation

jeffbl
Copy link
Member

@jeffbl jeffbl commented Apr 29, 2024

This PR is for text changes to README files, plus moving two handlers into the "deprecated" directory since they were already marked deprecated in their README files (so I assume they were no longer being built, but I did not verify). There were some missing README files for some of the debug handlers, so I added stub READMEs that should still be filled out.

@JRegimbal assigning to you for an overall look, to make sure I've labeled appropriately based on guidelines in work item, with a bit of judgment where it was fuzzy.

@jaydeepsingh25 ping in case you want to look at the preprocessor alpha/beta decisions, but not necessary.

Please ensure you've followed the checklist and provide all the required information before requesting a review.
If you do not have everything applicable to your PR, it will not be reviewed!
If you don't know what something is or if it applies to you, ask!

Don't delete below this line.


Required Information

  • I referenced the issue addressed in this PR.
  • I described the changes made and how these address the issue.
  • I described how I tested these changes.

Coding/Commit Requirements

  • I followed applicable coding standards where appropriate (e.g., PEP8)
  • I have not committed any models or other large files.

New Component Checklist (mandatory for new microservices)

  • I added an entry to docker-compose.yml and build.yml.
  • I created A CI workflow under .github/workflows.
  • I have created a README.md file that describes what the component does and what it depends on (other microservices, ML models, etc.).

OR

  • I have not added a new component in this PR.

…alpha/beta text to preprocessor and handler READMEs
@jeffbl jeffbl added the documentation Improvements or additions to documentation label Apr 29, 2024
@jeffbl jeffbl requested a review from JRegimbal April 29, 2024 21:07
@jeffbl jeffbl linked an issue Apr 29, 2024 that may be closed by this pull request
@jeffbl
Copy link
Member Author

jeffbl commented Apr 29, 2024

I have now disabled the hello-haptics-handler workflow action since that handler is now in the deprecated directory. I think this is the only one.

Note that there are errors for other PEP8 issues in some handlers/preprocessors that are precluding building. I don't believe these were caused by this PR, but were existing issues that are being hit due to attempted building via github actions.

Copy link
Collaborator

@JRegimbal JRegimbal left a comment

Choose a reason for hiding this comment

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

Generally seems good. The only thing that sticks out to me is that the SVG debug handlers are labelled as "ready to be tested by end users", which is odd if they're explicitly visual debugging resources.

@jeffbl
Copy link
Member Author

jeffbl commented May 1, 2024

Generally seems good. The only thing that sticks out to me is that the SVG debug handlers are labelled as "ready to be tested by end users", which is odd if they're explicitly visual debugging resources.

OK, going to merge. Yes, agree that they are visual debugging resources, but I'd say they are at a quality level where 1. they are deployed in production, and 2. could be used by end users reliably, including developers. If we labelled these alpha, it might deter use even for debugging...

@jeffbl jeffbl merged commit cb255e5 into main May 1, 2024
71 of 72 checks passed
@jeffbl jeffbl deleted the alpha-beta branch May 1, 2024 20:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clarify status of project/handlers/preprocessors in README files
2 participants