Add documentation for how embedding works #5023
Conversation
pezholio
force-pushed
the
content-modelling/917-add-docs-for-content-modelling-flow
branch
from
ad6100b to
8f52c7d
Compare
This adds some information about the flow of embeds, as well as how changes are propogated. There was a bit of duplication in the preview section, so I’ve updated it to link to this new section.
pezholio
force-pushed
the
content-modelling/917-add-docs-for-content-modelling-flow
branch
from
8f52c7d to
0a394ef
Compare
| Content Block Embedding is mainly handled in the [Publishing API](https://github.com/alphagov/publishing-api/), with some shared code in the | ||
| [Content Block Tools gem](https://github.com/alphagov/govuk_content_block_tools) detailed in the diagram and steps below: | ||
|
|
||
| <pre lang="mermaid"> |
There was a problem hiding this comment.
should I be able to see this as a diagram on the frontend? or is it something I need to plug in elsewhere?
There was a problem hiding this comment.
(cool idea if we can get to see the diagram - I've only ever made fiddly sequence diagrams by hand so this would be great!)
There was a problem hiding this comment.
Yeah, it should work. I added the extra JS needed in #5019
There was a problem hiding this comment.
Here's a screenshot:
There was a problem hiding this comment.
ah ok, it wasn't showing when I ran through docker locally - is it possible to add a yarn install step to the local docker config? It looks like it can be added in the Makefile for a project?
There was a problem hiding this comment.
Ah yeah, I'll sort that 👍
pezholio
deleted the
content-modelling/917-add-docs-for-content-modelling-flow
branch
Trello card: https://trello.com/c/JfbTFW0e/917-tech-documentation
This adds some information about the flow of embeds, as well as how changes are propogated. There was a bit of duplication in the preview section, so I’ve updated it to link to this new section.