search

pact-foundation / pact-js

JS version of Pact. Pact is a contract testing framework for HTTP APIs and non-HTTP asynchronous messaging systems.
https://pact.io
Other
1.59k stars 343 forks source link

Diagrams in messages document are not rendered #1030

Closed tienvx closed 9 months ago

tienvx commented 1 year ago

Software versions

NA

Issue Checklist

NA

Expected behaviour

Diagrams should be rendered

Actual behaviour

Diagrams are not rendered

Steps to reproduce

Relevant log files

NA

rubemfsv commented 9 months ago

@mefellows I just resolved here: https://github.com/pact-foundation/pact-js/pull/1119

rubemfsv commented 9 months ago

Resolved and merged https://github.com/pact-foundation/pact-js/pull/1119 @YOU54F I think it is interesting to close this issue then. Thanks!

YOU54F commented 9 months ago

Not quite just yet unfortunately 😓

  1. we need to check it renders on the site to close this issue
  2. is isn't actually rendering on the site post the update https://docs.pact.io/implementation_guides/javascript/docs/messages

it's unrelated to your change, but related to the docs sync job, which appears to require ?raw=true for the images to render

https://github.com/pact-foundation/docs.pact.io/commit/b4a393bee28e649606a34ac0a1c293bf0aad8a9d#diff-dd41eeae0d557ea0bd62cbcb2548f88613902e11ed50f3d0d90b547494a129ccL23

See related issue here

https://github.com/pact-foundation/docs.pact.io/issues/265#issuecomment-1693304713

YOU54F commented 9 months ago

I think the links just need to be raw githubusercontent links, ie

https://raw.githubusercontent.com/pact-foundation/pact-js/master/docs/diagrams/message-provider.png which would resolve it on the site, and when viewed on the repo