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

Add instructions how to run ingestion script from command line #4083

Conversation

kuephi
Copy link
Contributor

@kuephi kuephi commented Apr 9, 2024

Fixes

Fixes #2799 by @stacimc

Description

Added documentation how to run ingestion script via cli

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • I ran the DAG documentation generator (if applicable).

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@kuephi kuephi requested a review from a team as a code owner April 9, 2024 12:44
@kuephi kuephi requested review from krysal and sarayourfriend April 9, 2024 12:44
@openverse-bot openverse-bot added 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work 🏷 status: label work required Needs proper labelling before it can be worked on 🟩 priority: low Low priority and doesn't need to be rushed ✨ goal: improvement Improvement to an existing user-facing feature 📄 aspect: text Concerns the textual material in the repository labels Apr 9, 2024
Copy link
Collaborator

@sarayourfriend sarayourfriend left a comment

Choose a reason for hiding this comment

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

LGTM! I am going to push two very small changes to align with our other "run this command" code blocks, but otherwise this is great. Thanks very much for the contribution @kuephi 🙏

documentation/catalog/guides/adding_a_new_provider.md Outdated Show resolved Hide resolved
documentation/catalog/guides/adding_a_new_provider.md Outdated Show resolved Hide resolved
@obulat obulat changed the title Issue 2799: added instructions how to run ingestion script from command line Add instructions how to run ingestion script from command line Apr 10, 2024
@obulat obulat added 🧱 stack: catalog Related to the catalog and Airflow DAGs and removed 🏷 status: label work required Needs proper labelling before it can be worked on 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels Apr 10, 2024
Copy link
Collaborator

@AetherUnbound AetherUnbound left a comment

Choose a reason for hiding this comment

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

Thanks for the contribution @kuephi! Unfortunately, many of the catalog's provider scripts depend on Airflow and must be run from within the Docker stack. The issue (#2799) describes how this might be accomplished. Do you mind altering these instructions to direct users how to use the docker-related just commands instead? E.g. just catalog/run bash and then the python command needed to run the provider.

@kuephi
Copy link
Contributor Author

kuephi commented Apr 12, 2024

will have a look @AetherUnbound

@krysal krysal marked this pull request as draft April 15, 2024 13:47
@kuephi
Copy link
Contributor Author

kuephi commented Apr 18, 2024

changed it according to your comment. had to add a new command to the catalog justfile too. Hope this will do it.

Copy link
Collaborator

@AetherUnbound AetherUnbound left a comment

Choose a reason for hiding this comment

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

Thanks for making the change, this looks great! I have one change requested around spelling. Also, it looks like linting is failing - would you be able to run just lint locally and address/commit the changes it's suggesting?

documentation/catalog/guides/adding_a_new_provider.md Outdated Show resolved Hide resolved
@AetherUnbound AetherUnbound marked this pull request as ready for review April 18, 2024 23:50
Copy link
Collaborator

@AetherUnbound AetherUnbound 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 the contribution! 😄

@AetherUnbound AetherUnbound merged commit 90584a9 into WordPress:main Apr 19, 2024
40 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📄 aspect: text Concerns the textual material in the repository ✨ goal: improvement Improvement to an existing user-facing feature 🟩 priority: low Low priority and doesn't need to be rushed 🧱 stack: catalog Related to the catalog and Airflow DAGs
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Add instructions for running ingestion via the CLI
6 participants