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

Organize examples #126

Merged
merged 17 commits into from
Feb 28, 2024
Merged

Organize examples #126

merged 17 commits into from
Feb 28, 2024

Conversation

bryannho
Copy link
Contributor

@bryannho bryannho commented Feb 27, 2024

Closes #100

  • Reorganizes doc/examples so that each example goes by framework/example-name
  • Removed Dockerfile for examples which no longer need it, ie. Solara (previously those frameworks needed to be deployed as Docker apps but now we support them natively)
  • Once this is merged, will open a PR to cloud-frontend to update the locations of a few example apps. Once that is merged, will open another PR to doc to delete the old examples that were moved

📚 Documentation preview 📚: https://ploomber-doc--126.org.readthedocs.build/en/126/

@bryannho bryannho marked this pull request as ready for review February 27, 2024 18:43
@bryannho bryannho requested a review from edublancas as a code owner February 27, 2024 18:43
@bryannho
Copy link
Contributor Author

@edublancas ready for review

Moved most of the examples out of the Docker folder, and into a folder for their own framework, ie. examples/docker/example-name -> examples/framework/example-name.

Removed Dockerfile from projects that no longer need it. Made sure those which had Dockerfiles removed will still deploy correctly (had to edit/create a requirements.txt for those apps)

The only app for which I couldn't remove the Dockerfile for was solara/keyword-extraction, because it requires some additional commands to be run in the Dockerfile (apart from just installing the requirements).

Copy link
Contributor

Choose a reason for hiding this comment

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

let's remove this file (i guess there's another copy as well). this shouldn't've been merged so let's get rid of it)

this is from some old example

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Deleted this file and its copy

@bryannho bryannho requested a review from edublancas February 27, 2024 23:31
@edublancas edublancas merged commit 403168e into ploomber:main Feb 28, 2024
1 check passed
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.

organize examples
2 participants