Skip to content

Latest commit

 

History

History
44 lines (27 loc) · 2.44 KB

README.md

File metadata and controls

44 lines (27 loc) · 2.44 KB
Raw

openfoodfacts-web

IMPORTANT: This project contains static contents for openfoodfacts product-opener project. If you're looking for the server side version of Open Food Facts, look at product-opener instead of this repository.

Having those file in a separate project helps being more agile on translations delivery.

Help translate

https://crowdin.com/project/openfoodfacts

Adding a new page or updating an existing page

  • Create a pull request on openfoodfacts-web with the new or modified HTML file (you can do that with the "GitHub Desktop" app if you are unfamiliar with the command line)
  • Set it up for translation in the .crowdin file
  • Once the pull request gets approved and merged, it will be deployed on the test server
  • Deployment to production is still manual

Requirements

  • Do not hotlink ressources like images, JS or CSS. They need to be commited to the repository. Please organize resources in folders.

Deployment

Actual prod (no docker)

  1. Move the /lang dir from openfoodfacts-server to openfoodfacts-resources (or maybe to make things even cleaner, to a new repo openfoodfacts-web. It's unclear if everything in openfoodfacts-resources is supposed to be available as-is on the web server).

  2. Create a /html/images/texts/ directory in openfoodfacts-web so that we can put the new images needed by texts there (we don't have to move the existing ones right away).

That way for deployment, we can just copy /lang and /html to /srv/off/ and it will work.

On docker

See openfoodfacts-server:docs/how-to-guides/using-pages-from-openfoodfacts-web.md

And that's it! That would be already be enough of a big change for a first step. Then we can have a look at what we have in /html/ to see what we should move, one by one.

Tools