Skip to content

Commit 1cfcee8

Browse files
authored
Update README.md
1 parent 96054ec commit 1cfcee8

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -263,6 +263,24 @@ $ docker-compose up --detach --build service
263263
$ docker-compose up --detach --build crawler
264264
```
265265

266+
### Limitations
267+
268+
When you look at a definition in the UI and create a curation (this uses the API call PATCH /curations), the curation WILL be opened
269+
as a pull request on the [curated-data-dev](https://github.com/clearlydefined/curated-data-dev), but you will not see it
270+
under the "Curations" section when you refresh the definition's page.
271+
272+
In the Azure dev and production environment, creating a curation will open a PR on the appropriate github curated-data repo,
273+
and then, once the pull request is open, GitHub will then use a webhook.
274+
275+
The webhook will POST to an Azure logic app. That app will then put the curation on the Azure storage queue, which is how it will
276+
end up in the curation store (in this case, mongo).
277+
278+
I haven't yet figured out a way to do this without an Azure logic app (but will continue looking into this). I did try
279+
creating a GitHub webhook to POST to http://localhost:4000, but GitHub requires that the webhooks it POSTs to be
280+
accessible over the public internet.
281+
282+
When I figure out a solution, I will update this README.
283+
266284
### Stopping containers
267285

268286
You can stop and destroy the containers in the shell where you ran `docker-compose up` with CTRL c.

0 commit comments

Comments
 (0)