thrift icon indicating copy to clipboard operation
thrift copied to clipboard

THRIFT-5634: thrift docs picture was broken

Open iceprosurface opened this issue 2 years ago • 2 comments

  • [x] Did you create an Apache Jira ticket? (not required for trivial changes)
    • https://issues.apache.org/jira/browse/THRIFT-5634
  • [x] If a ticket exists: Does your pull request title follow the pattern "THRIFT-NNNN: describe my issue"?
  • [x] Did you squash your changes to a single commit? (not required, but preferred)
  • [x] Did you do your best to avoid breaking changes? If one was needed, did you label the Jira ticket with "Breaking-Change"?
  • [ ] If your change does not involve any code, include [skip ci] anywhere in the commit message to free up build resources.

change :

https://thrift.apache.org/docs/doc/images/cgrn.png -> https://thrift.apache.org/doc/images/cgrn.png https://thrift.apache.org/docs/doc/images/cred.png -> https://thrift.apache.org/doc/images/cred.png

iceprosurface avatar Sep 21 '22 05:09 iceprosurface

i wonder what is a better fix, to change all relative paths to absolute one or to just update somewhere once to fix the docs prefix?

jimexist avatar Sep 21 '22 05:09 jimexist

i wonder what is a better fix, to change all relative paths to absolute one or to just update somewhere once to fix the docs prefix?

This is determined by the location of the static resource (image).

For example:

https://thrift.apache.org/docs/Languages.html was under /docs/, so that relative assets will load with prefix /docs/

doc/images/cgrn.png-> /docs/doc/images/cgrn.png

However if we change correct relative path -> ../doc/images/cgrn.png, this will break github preview.

Move doc/images to docs/images, then add the /docs prefix to every static resource(image), maybe this is a better fix.

Change all doc will break search result of search engine.

iceprosurface avatar Sep 21 '22 06:09 iceprosurface