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.

Sign up for GitHub

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

Jump to bottom

Improvements based on use case partner feedback #293

Merged
merged 39 commits into from
Sep 14, 2022
Merged

Improvements based on use case partner feedback #293

merged 39 commits into from
Sep 14, 2022

Conversation

passalis
Copy link
Collaborator

@passalis passalis commented Aug 31, 2022 •
edited
Loading

This PR includes the following changes:

  • Removed wrongly placed __init__.py.
  • Included a python folder in projects where all python examples are placed to avoid mixing them with the C examples and ROS nodes.
  • Improved structure of the documentation and toolkit to make it more user friendly.
  • Improved projects documentation.
  • A dedicated page that includes compatibility issues.
  • Additional information on how to modify a docker image without rebuilding it.
  • Information on how customizing ROS pipelines and running multiple tools
  • Instructions on how to build custom docker images that do not include the whole toolkit
  • Group ROS nodes based on the input they receive in order to make it easier for users to understand how to use them.

@passalis passalis marked this pull request as draft August 31, 2022 09:56
This was referenced Aug 31, 2022
Closed
Closed
@passalis passalis marked this pull request as ready for review August 31, 2022 12:56
stefaniapedrazzi
stefaniapedrazzi requested changes Sep 1, 2022
View reviewed changes
Copy link
Collaborator

@stefaniapedrazzi stefaniapedrazzi left a comment

Choose a reason for hiding this comment

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

Thank you for these improvements!

I think it would be also nice to add the two new pages "issues.md" and "customize.md" in docs/reference/index.md

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/reference/customize.md Outdated Show resolved Hide resolved
docs/reference/customize.md Outdated Show resolved Hide resolved
docs/reference/issues.md Outdated Show resolved Hide resolved
docs/reference/issues.md Outdated Show resolved Hide resolved
passalis and others added 4 commits September 1, 2022 13:05
@passalis @stefaniapedrazzi
Apply suggestions from code review
04e21a9 
Co-authored-by: Stefania Pedrazzi <stefaniapedrazzi@users.noreply.github.com>
@passalis
Link updated
52e13ae
@passalis
Update index.md
e228515
@passalis
Updated released index
d844b79
@passalis passalis added test sources Run style checks test tools Test the toolkit methods test release Tests if a wheel created from a branch runs correctly labels Sep 1, 2022
@passalis
Copy link
Collaborator Author

passalis commented Sep 1, 2022

I agree, I moved it to the bottom. I also added the labels for running the tests, just to be safe.

@passalis passalis removed the test tools Test the toolkit methods label Sep 12, 2022
@passalis
Copy link
Collaborator Author

This is now ready for review again.

stefaniapedrazzi
stefaniapedrazzi requested changes Sep 13, 2022
View reviewed changes
Copy link
Collaborator

@stefaniapedrazzi stefaniapedrazzi left a comment

Choose a reason for hiding this comment

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

Thank you!

projects/opendr_ws/README.md Outdated Show resolved Hide resolved
@passalis @stefaniapedrazzi
Update projects/opendr_ws/README.md
dbaf219 
Co-authored-by: Stefania Pedrazzi <stefaniapedrazzi@users.noreply.github.com>
@passalis passalis merged commit 795b199 into develop Sep 14, 2022
@passalis passalis deleted the feedback_improvements branch September 14, 2022 07:43
lucamarchionni pushed a commit to lucamarchionni/opendr that referenced this pull request Jun 10, 2024
@stefaniapedrazzi
Improvements based on use case partner feedback (opendr-eu#293)
75fd9c3 
* removed wrongly placed file

* Update README.md

* restructured projects

* Update README.md

* Create README.md

* removed __init__.py

* Create issues.md

* Update issues.md

* Update customize.md

* Update README.md

* Apply suggestions from code review

Co-authored-by: Stefania Pedrazzi <stefaniapedrazzi@users.noreply.github.com>

* Link updated

* Update index.md

* Updated released index

* Update index.md

* Fix old link

* Update test_license.py

* Updated projects path

* Updated links to projects

* Updated links to projects

* Fixed projects path

* pep8 fixes

* Categorized nodes according to their input

* Custom model loading example

* Issues for colab

* Update issues.md

* Update projects/opendr_ws/README.md

Co-authored-by: Stefania Pedrazzi <stefaniapedrazzi@users.noreply.github.com>

Co-authored-by: Stefania Pedrazzi <stefaniapedrazzi@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tsampazk tsampazk tsampazk approved these changes

@stefaniapedrazzi stefaniapedrazzi stefaniapedrazzi approved these changes

@omichel omichel Awaiting requested review from omichel omichel is a code owner

@ad-daniel ad-daniel Awaiting requested review from ad-daniel

Assignees
No one assigned
Labels
test release Tests if a wheel created from a branch runs correctly test sources Run style checks
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@passalis @stefaniapedrazzi @tsampazk