Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Images missing from HTML version of spec #247

Closed
RobDolinMS opened this issue Sep 1, 2016 · 10 comments
Closed

Images missing from HTML version of spec #247

RobDolinMS opened this issue Sep 1, 2016 · 10 comments
Assignees
@vbatts
Labels
area/docs-html-pdf
Milestone
v1.0.0-rc4

Comments

@RobDolinMS
Copy link
Collaborator

Images are not rendering in the HTML released version of the Image Format spec (v0.4.0.)

The root cause MIGHT be that the HTML src= attributes seem to use relative URLs instead of absolute URLs.:

<p>The following figure shows how the above media types reference each other:</p>
<p><img src="img/media-types.png" /></p>

NOTE: Images ARE rendering in PDF version of spec :)
@RobDolinMS
Copy link
Collaborator Author

I recommend tagging with Milestone = v1.0.0 since this should not block any minor releases, but would be good to resolve before a v1 release.

@philips
Copy link
Contributor

philips commented Sep 1, 2016

cc @vbatts

@vbatts vbatts added this to the v1.0.0 milestone Sep 7, 2016
@vbatts
Copy link
Member

vbatts commented Sep 7, 2016

i think this is because the pdf inlines the images, but the html expects to find the images.
I went down the road to base64 encode and html inline the images, that was not real great for this doc process.

I could attach those img/ files in the release docs. That would seem sufficient to me. WDYT @RobDolinMS ?

@wking
Copy link
Contributor

wking commented Sep 7, 2016

On Wed, Sep 07, 2016 at 12:21:19PM -0700, Vincent Batts wrote:

I went down the road to base64 encode and html inline the images,
that was not real great for this doc process.

If the goal is to produce a single-page version of the spec, I think
we can save a lot of headache by writing it up in one big Markdown
file (opencontainers/runtime-spec#264 had something similar, but we
don't even need that much magic). Or we can switch to
reStructuredText or some other format that's designed with this sort
of “produce compilable documentation” goal in mind.

@philips philips modified the milestones: v1.0.0-rc1, v1.0.0 Sep 13, 2016
@vbatts
Copy link
Member

vbatts commented Sep 27, 2016

i've spent some cycles on this, and still do not have a solution yet.
I realize the concern, but worse-comes-to-worse, I'd drop the single page HTML and only provide PDF rather than so-grossly hack this in.

@vbatts vbatts modified the milestones: v1.0.0-rc2, v1.0.0-rc1 Sep 27, 2016
@philips
Copy link
Contributor

philips commented Oct 19, 2016

As Rob says above, this is low priority, moving to rc3.

@philips philips modified the milestones: v1.0.0-rc3, v1.0.0-rc2 Oct 19, 2016
@philips
Copy link
Contributor

philips commented Nov 30, 2016

I am moving this to rc4 based on discussion on the mailing list that HTML and PDF isn't really the end goal as much as a top to bottom readable spec: https://groups.google.com/a/opencontainers.org/forum/#!topic/dev/XNreeSORPTQ

@philips philips modified the milestones: v1.0.0-rc4, v1.0.0-rc3 Nov 30, 2016
@RobDolinMS
Copy link
Collaborator Author

Per chat on OCI Dev ConCall, a partial (and sufficient) solution would be for a /img/ directory to be included with the release. When the HTML spec is published, the /img/ directory should be published in the same location and the images will render.

@vbatts
Copy link
Member

vbatts commented Jan 26, 2017

two things @RobDolinMS

  • @wking's idea of an HTML <base> tag works fine, and will fetch the images from the tagged version on github. I've manually updated the RC3 and RC2 html documents with this approach.
  • I, or someone, will take a stab at a PR to get this in the make docs target so it is not a manual process.

For posterity, it is adding to the top of the *.html file:

<!DOCTYPE html>
<html lang="en-US">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
    <title>image-spec v1.0.0-rc3</title>
    <base href="https://raw.githubusercontent.com/opencontainers/image-spec/v1.0.0-rc3/">
  </head>
  <body>

and to the tail of it:

</body>
</html>

vbatts added a commit to vbatts/oci-image-spec that referenced this issue Jan 31, 2017
@vbatts
docs: image base reference
708416f 
Fixes opencontainers#247

this makes an ephemeral header that gets included into the html doc that
bases the images path to pull from the same tag on github.

Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
@vbatts vbatts mentioned this issue Jan 31, 2017
Merged
@vbatts
Copy link
Member

vbatts commented Jan 31, 2017 via email

vbatts added a commit to vbatts/oci-image-spec that referenced this issue Jan 31, 2017
@vbatts
docs: image base reference
b276c64 
Fixes opencontainers#247

this makes an ephemeral header that gets included into the html doc that
bases the images path to pull from the same tag on github.

Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
vbatts added a commit to vbatts/oci-image-spec that referenced this issue Jan 31, 2017
@vbatts
docs: image base reference
5cf770b 
Fixes opencontainers#247

this makes an ephemeral header that gets included into the html doc that
bases the images path to pull from the same tag on github.

Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
vbatts added a commit to vbatts/oci-image-spec that referenced this issue Feb 1, 2017
@vbatts
docs: image base reference
cec7700 
Fixes opencontainers#247

this makes an ephemeral header that gets included into the html doc that
bases the images path to pull from the same tag on github.

Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
vbatts added a commit to vbatts/oci-image-spec that referenced this issue Feb 2, 2017
@vbatts
docs: image base reference
7692fe4 
Fixes opencontainers#247

this makes an ephemeral header that gets included into the html doc that
bases the images path to pull from the same tag on github.

Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
vbatts added a commit to vbatts/oci-image-spec that referenced this issue Mar 8, 2017
@vbatts
docs: image base reference
6aea159 
Fixes opencontainers#247

this makes an ephemeral header that gets included into the html doc that
bases the images path to pull from the same tag on github.

Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
vbatts added a commit to vbatts/oci-image-spec that referenced this issue Mar 8, 2017
@vbatts
docs: image base reference
fec31f4 
Fixes opencontainers#247

this makes an ephemeral header that gets included into the html doc that
bases the images path to pull from the same tag on github.

Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@vbatts vbatts

Labels
area/docs-html-pdf
Projects
None yet
Milestone
v1.0.0-rc4
Development

No branches or pull requests
4 participants
@philips @vbatts @wking @RobDolinMS