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

updating naming conventions of different API #946

Conversation

kta-intel
Copy link
Collaborator

@kta-intel kta-intel commented Mar 14, 2024

This PR:

  • updates the naming convention of the different API options throughout the repo and docs
    • aggregator-based workflow -> Task Runner API
    • director-based workflow -> Interactive API
    • workflow interface -> Workflow API

TODO:

  • Update workflow_interface notebook names to workflow_api and requirements_workflow_interface.txt to requirements_workflow_api.txt
    • within notebooks, need to update the requirements cell to point at updated name

@kta-intel kta-intel changed the title WIP: updating naming conventions of API updating naming conventions of different API in readthedocs Mar 16, 2024
@kta-intel kta-intel marked this pull request as ready for review March 16, 2024 20:21
@kta-intel kta-intel changed the title updating naming conventions of different API in readthedocs updating naming conventions of different API Apr 1, 2024
@kta-intel kta-intel marked this pull request as draft April 1, 2024 19:32
@kta-intel kta-intel changed the title updating naming conventions of different API WIP: updating naming conventions of different API Apr 1, 2024
@kta-intel kta-intel force-pushed the kta-intel/update_api_naming branch from 38600ca to 3e834d6 Compare May 9, 2024 22:00
@kta-intel kta-intel marked this pull request as ready for review May 10, 2024 21:02
@kta-intel kta-intel changed the title WIP: updating naming conventions of different API updating naming conventions of different API May 10, 2024
@kta-intel kta-intel force-pushed the kta-intel/update_api_naming branch from 30c5cd3 to 09f87d6 Compare May 10, 2024 21:09
Copy link
Collaborator

@nammbash nammbash left a comment

Choose a reason for hiding this comment

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

Looks good to me Kevin.

Just a FYI for the future.
What is the difference between workflow_101 and workflow_1001 examples

Note from Patrick: "101 is the minimal example. 1001 is the same thing but includes workspace export. It should be renamed to a different number to avoid this type of confusion."

something to change in the future.

Copy link
Collaborator

@manuelhsantana manuelhsantana left a comment

Choose a reason for hiding this comment

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

After reviewed the PR, which updates API naming conventions and fixes broken links. The changes from "aggregator-based workflow" to "Task Runner API," "director-based workflow" to "Interactive API," and "workflow interface" to "Workflow API" are correctly implemented throughout the code and documentation. All new links are functional.

The PR is accurate and ready for merge.

LGTM, Manuel

@kta-intel kta-intel closed this Dec 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants