-
Notifications
You must be signed in to change notification settings - Fork 50
Add terms of service to included files for docker image #662
Conversation
While this PR does work as intended, based on the minified nature of the file and this comment
it seems like the file is auto-generated. I'm not sure if it should even be tracked in VCS. |
Here's the file in prod now: https://api.openverse.engineering/terms_of_service.html |
Imo, we should convert this into a markdown file and serve it inside the ReDoc view itself, similar to how we have these other sections in the API documentation. This has the main advantage of being immediately discoverable (lives with the API docs) and very readable in both the web UI as well as in the raw Markdown format (which the minified HTML lacks). Also, it can be Git-tracked which is not true for minified auto-generated HTML files. |
That's a great idea Dhruv! |
Agreed! But bummer, the |
Can't it point to a URL... that it itself generates? Or... 🤔 It could just be the fully qualified URL to the production place where it will exist? |
Yea, exactly that! I just need to figure out how to get a "regular page" up in Swagger, I haven't used it very much 😅 |
Oh you know, I was assuming we'd add it to the MyST docs, not the swagger docs, sorry! |
🤦🏼♀️ I was assuming it had to be in the swagger docs! Since it's literally just a link, we could 1000% make it the MyST docs! So much easier 🚀 |
Nice! |
The changes are pretty significant and result in a very different PR, so I'm going to close this one and open a new one. |
Description
This PR addresses a minor issue wherein the terms of service document was not available within the Docker container, and thus couldn't be served by nginx in production.
Testing Instructions
just build
docker run --entrypoint='' --rm -it openverse-api:latest ls
terms_of_service.html
is present within the container.Checklist
Update index.md
).main
) or a parent feature branch.Developer Certificate of Origin
Developer Certificate of Origin