Skip to content

Commit

Permalink
Move catalog README to docs site quickstart (#3204)
Browse files Browse the repository at this point in the history
  • Loading branch information
AetherUnbound authored Oct 18, 2023
1 parent 8a9f6e1 commit 90396b2
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 21 deletions.
1 change: 1 addition & 0 deletions documentation/catalog/guides/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,6 @@
```{toctree}
:titlesonly:
quickstart
deploy
```
32 changes: 11 additions & 21 deletions catalog/README.md → documentation/catalog/guides/quickstart.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,4 @@
<img src="https://github.com/WordPress/openverse/raw/main/brand/banner.svg" width="100%"/>

<p align="center">
<a href="https://github.com/orgs/WordPress/projects/3">Project Board</a> | <a href="https://make.wordpress.org/openverse/">Community Site</a> | <a href="https://make.wordpress.org/chat/">#openverse @ Slack</a> | <a href="https://make.wordpress.org/openverse/handbook/">Handbook</a> | <a href="https://www.figma.com/file/w60dl1XPUvSaRncv1Utmnb/Openverse-Releases">Figma Mockups</a> | <a href="https://www.figma.com/file/GIIQ4sDbaToCfFQyKMvzr8/Openverse-Design-Library">Figma Design Library</a>
</p>

# Openverse Catalog
# Quickstart

This repository contains the methods used to identify over 1.4 billion Creative
Commons licensed works. The challenge is that these works are dispersed
Expand All @@ -22,7 +16,7 @@ the internet.
### API Workflows

To view more information about all the available workflows (DAGs) within the
project, see [DAGs.md](catalog/DAGs.md).
project, see [DAGs.md](../reference/DAGs.md).

See each provider API script's notes in their respective [handbook][ov-handbook]
entry.
Expand Down Expand Up @@ -64,7 +58,8 @@ The steps above were performed in [`ExtractCCLinks.py`][ex_cc_links].
This method was retired in 2021.

[ccrawl_doc]: https://commoncrawl.org/the-data/get-started/
[ex_cc_links]: archive/ExtractCCLinks.py
[ex_cc_links]:
https://github.com/WordPress/openverse/blob/c20262cad8944d324b49176678b16b230bc57e2e/archive/ExtractCCLinks.py

## Development setup for Airflow and API puller scripts

Expand All @@ -75,9 +70,10 @@ different environment than the PySpark portion of the project, and so have their
own dependency requirements.

For instructions geared specifically towards production deployments, see
[DEPLOYMENT.md](DEPLOYMENT.md)
[DEPLOYMENT.md](https://github.com/WordPress/openverse/blob/main/catalog/DEPLOYMENT.md)

[api_scripts]: catalog/dags/providers/provider_api_scripts
[api_scripts]:
https://github.com/WordPress/openverse/blob/main/catalog/dags/providers/provider_api_scripts

### Requirements

Expand Down Expand Up @@ -226,9 +222,10 @@ just recreate
> `DC_USER=root` environment variable for `just` recipes. For example, see the
> [generate-dag-docs recipe](https://github.com/WordPress/openverse-catalog/blob/c9be67e483e49e9eda7cd21b52bcde8857cd3922/justfile#L126).
[justfile]: justfile
[dockercompose]: catalog/docker-compose.yml
[cc_airflow]: catalog/
[justfile]: https://github.com/WordPress/openverse/blob/main/catalog/justfile
[dockercompose]:
https://github.com/WordPress/openverse/blob/main/docker-compose.yml
[cc_airflow]: https://github.com/WordPress/openverse/tree/main/catalog

## Directory Structure

Expand Down Expand Up @@ -291,13 +288,6 @@ previous team members @ryanmerkley, @janetpkr, @lizadaly, @sebworks, @pa-w,
along with their
[community of volunteers](https://opensource.creativecommons.org/community/community-team/).

## License

- [`LICENSE`](LICENSE) (Expat/[MIT][mit] License)

[mit]:
http://www.opensource.org/licenses/MIT
"The MIT License | Open Source Initiative"
[wp_slack]: https://make.wordpress.org/chat/
[cc]: https://creativecommons.org
[cc_community]: https://opensource.creativecommons.org/community/community-team/

0 comments on commit 90396b2

Please sign in to comment.