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

[Docs] Better explain the exports of this repository #746

Closed
zackkrida opened this issue Sep 19, 2021 · 1 comment
Closed

[Docs] Better explain the exports of this repository #746

zackkrida opened this issue Sep 19, 2021 · 1 comment
Labels
📄 aspect: text Concerns the textual material in the repository ✨ goal: improvement Improvement to an existing user-facing feature help wanted Open to participation from the community 🟩 priority: low Low priority and doesn't need to be rushed 🧱 stack: documentation Related to Sphinx documentation 🧱 stack: mgmt Related to repo management and automations

Comments

@zackkrida
Copy link
Member

Problem

It's not clear what build artifacts this repository produces. In reality, it is used to generate multiple Docker containers and the api service. We should add documentation for all of these in the README.
@zackkrida zackkrida added 🟩 priority: low Low priority and doesn't need to be rushed 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work ✨ goal: improvement Improvement to an existing user-facing feature 💻 aspect: code Concerns the software code in the repository 📄 aspect: text Concerns the textual material in the repository and removed 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work 💻 aspect: code Concerns the software code in the repository labels Sep 19, 2021
@dhruvkb dhruvkb mentioned this issue Dec 29, 2021
Merged
7 tasks
@sarayourfriend sarayourfriend added the help wanted Open to participation from the community label Dec 16, 2022
@obulat obulat transferred this issue from WordPress/openverse-api Feb 22, 2023
dhruvkb pushed a commit that referenced this issue Apr 14, 2023
@AetherUnbound @stacimc
Refactor Freesound to use ProviderDataIngester (#746)
8f92318 
* Initial refactor steps

* Move functions

* Refactor other functions

* Update tests

* Add class to workflow list

* Remove TODO note

* Update DAGs.md

* Fixes identified in PR review

Co-authored-by: Staci Cooper <63313398+stacimc@users.noreply.github.com>

* Simplify some logic

* Remove per-license selection logic

* Simplify URL acquisition & tests

Co-authored-by: Staci Cooper <63313398+stacimc@users.noreply.github.com>
@AetherUnbound
Copy link
Contributor

I believe @dhruvkb has outlined this well in our documentation! https://docs.openverse.org/meta/ci_cd/artifacts.html

@AetherUnbound AetherUnbound added 🧱 stack: mgmt Related to repo management and automations 🧱 stack: documentation Related to Sphinx documentation and removed 🧱 stack: backend labels May 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
📄 aspect: text Concerns the textual material in the repository ✨ goal: improvement Improvement to an existing user-facing feature help wanted Open to participation from the community 🟩 priority: low Low priority and doesn't need to be rushed 🧱 stack: documentation Related to Sphinx documentation 🧱 stack: mgmt Related to repo management and automations
Projects
Openverse Backlog
Archived in project
Milestone
No milestone
Development

No branches or pull requests
4 participants
@zackkrida @AetherUnbound @obulat @sarayourfriend