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.

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

docs.zip does not contain resources at the root anymore [SPR-16799] #21339

Closed
spring-issuemaster opened this Issue May 8, 2018 · 4 comments

Comments

Projects
None yet
2 participants
@spring-issuemaster
Copy link
Collaborator

spring-issuemaster commented May 8, 2018

Stéphane Nicoll opened SPR-16799 and commented

The change in #21329 actually broke the documentation release process as we expect html and pdfs to be available at the root. It looks like so far we've relied on duplicate information for this (which sounds indeed a bit weird).

I've copied over the files on the docs server to keep things consistent for now but we need to revisit this approach.


Affects: 5.0.6

Issue Links:

  • #21329 Task "docsZip" copies duplicate reference files

Referenced from: commits da6e9c6, e9f4dec

@spring-issuemaster

This comment has been minimized.

Copy link
Collaborator

spring-issuemaster commented May 8, 2018

Rossen Stoyanchev commented

Yikes.

So the current structure looks like this:

[master]$ tree -L 3 build/distributions/spring-framework-5.1.0.BUILD-SNAPSHOT-docs
build/distributions/spring-framework-5.1.0.BUILD-SNAPSHOT-docs
├── javadoc-api
│   ├── allclasses-frame.html
│   ├── allclasses-noframe.html
│   ├── constant-values.html
│   ├── deprecated-list.html
│   ├── help-doc.html
│   ├── index-files
│   │   ├── index-10.html
│   │   ├── index-11.html
│   │   ├── index-12.html
│   │   ├── index-13.html
│   │   ├── index-14.html
│   │   ├── index-15.html
│   │   ├── index-16.html
│   │   ├── index-17.html
│   │   ├── index-18.html
│   │   ├── index-19.html
│   │   ├── index-1.html
│   │   ├── index-20.html
│   │   ├── index-21.html
│   │   ├── index-22.html
│   │   ├── index-23.html
│   │   ├── index-24.html
│   │   ├── index-25.html
│   │   ├── index-26.html
│   │   ├── index-2.html
│   │   ├── index-3.html
│   │   ├── index-4.html
│   │   ├── index-5.html
│   │   ├── index-6.html
│   │   ├── index-7.html
│   │   ├── index-8.html
│   │   └── index-9.html
│   ├── index.html
│   ├── org
│   │   ├── aopalliance
│   │   ├── apache
│   │   └── springframework
│   ├── overview-frame.html
│   ├── overview-summary.html
│   ├── overview-tree.html
│   ├── package-list
│   ├── script.js
│   ├── serialized-form.html
│   └── stylesheet.css
├── kdoc-api
│   ├── spring-framework
│   │   ├── alltypes
│   │   ├── index.html
│   │   ├── index-outline.html
│   │   ├── org.springframework.beans.factory
│   │   ├── org.springframework.context.annotation
│   │   ├── org.springframework.context.support
│   │   ├── org.springframework.core.env
│   │   ├── org.springframework.jdbc.core
│   │   ├── org.springframework.jdbc.core.namedparam
│   │   ├── org.springframework.test.web.reactive.server
│   │   ├── org.springframework.ui
│   │   ├── org.springframework.web.client
│   │   ├── org.springframework.web.reactive.function.client
│   │   ├── org.springframework.web.reactive.function.server
│   │   └── package-list
│   └── style.css
└── spring-framework-reference
    ├── html5
    │   ├── core.html
    │   ├── data-access-appendix.html
    │   ├── data-access.html
    │   ├── images
    │   ├── index.html
    │   ├── integration-appendix.html
    │   ├── integration.html
    │   ├── languages.html
    │   ├── overview.html
    │   ├── stylesheets
    │   ├── testing.html
    │   ├── testing-webtestclient.html
    │   ├── tocbot-3.0.2
    │   ├── web.html
    │   └── web-reactive.html
    └── pdf
        ├── core.pdf
        ├── data-access-appendix.pdf
        ├── data-access.pdf
        ├── images
        ├── index.pdf
        ├── integration-appendix.pdf
        ├── integration.pdf
        ├── languages.pdf
        ├── overview.pdf
        ├── stylesheets
        ├── testing.pdf
        ├── testing-webtestclient.pdf
        ├── tocbot-3.0.2
        ├── web.pdf
        └── web-reactive.pdf

While this is fresh in your mind, can you clarify what exactly is missing, and also what part of the build or release process is expecting it.

@spring-issuemaster

This comment has been minimized.

Copy link
Collaborator

spring-issuemaster commented May 9, 2018

Stéphane Nicoll commented

So the situation previously to that PR being merged was a bit weird. The resources were copied in two places: in the html5 and pdf subdirectories of spring-framework-reference and also in the root of that directory.

Concretely, if you open /spring-framework-reference, you get the duplicated index.html that is defined in the html5 sub-folder.

Now that this PR is merged, we don't have duplicate data but all the links are broken. I've fixed that manually on the doc server (basically copying the resources) but we need to find out how to deal with the current situation. I don't know if users are relying on html5 and pdf.

@spring-issuemaster

This comment has been minimized.

Copy link
Collaborator

spring-issuemaster commented May 9, 2018

Rossen Stoyanchev commented

I've eliminated the html5 sub-directory and restored the expected layout of html files. This is what it looks like now:

[master]$ tree -L 3 build/distributions/spring-framework-5.1.0.BUILD-SNAPSHOT-docs
build/distributions/spring-framework-5.1.0.BUILD-SNAPSHOT-docs
├── javadoc-api
│   ├── allclasses-frame.html
│   ├── allclasses-noframe.html
│   ├── constant-values.html
│   ├── deprecated-list.html
│   ├── help-doc.html
│   ├── index-files
│   │   ├── index-10.html
│   │   ├── index-11.html
│   │   ├── index-12.html
│   │   ├── index-13.html
│   │   ├── index-14.html
│   │   ├── index-15.html
│   │   ├── index-16.html
│   │   ├── index-17.html
│   │   ├── index-18.html
│   │   ├── index-19.html
│   │   ├── index-1.html
│   │   ├── index-20.html
│   │   ├── index-21.html
│   │   ├── index-22.html
│   │   ├── index-23.html
│   │   ├── index-24.html
│   │   ├── index-25.html
│   │   ├── index-26.html
│   │   ├── index-2.html
│   │   ├── index-3.html
│   │   ├── index-4.html
│   │   ├── index-5.html
│   │   ├── index-6.html
│   │   ├── index-7.html
│   │   ├── index-8.html
│   │   └── index-9.html
│   ├── index.html
│   ├── org
│   │   ├── aopalliance
│   │   ├── apache
│   │   └── springframework
│   ├── overview-frame.html
│   ├── overview-summary.html
│   ├── overview-tree.html
│   ├── package-list
│   ├── script.js
│   ├── serialized-form.html
│   └── stylesheet.css
├── kdoc-api
│   ├── spring-framework
│   │   ├── alltypes
│   │   ├── index.html
│   │   ├── index-outline.html
│   │   ├── org.springframework.beans.factory
│   │   ├── org.springframework.context.annotation
│   │   ├── org.springframework.context.support
│   │   ├── org.springframework.core.env
│   │   ├── org.springframework.jdbc.core
│   │   ├── org.springframework.jdbc.core.namedparam
│   │   ├── org.springframework.test.web.reactive.server
│   │   ├── org.springframework.ui
│   │   ├── org.springframework.web.client
│   │   ├── org.springframework.web.reactive.function.client
│   │   ├── org.springframework.web.reactive.function.server
│   │   └── package-list
│   └── style.css
└── spring-framework-reference
 ├── core.html
 ├── data-access-appendix.html
 ├── data-access.html
 ├── images
 │   ├── aop-proxy-call.png
 │   ├── aop-proxy-plain-pojo-call.png
 │   ├── container-magic.png
 │   ├── DataAccessException.png
 │   ├── eclipse-setup-1.png
 │   ├── eclipse-setup-2.png
 │   ├── eclipse-setup-3.png
 │   ├── ejb.png
 │   ├── ejb.svg
 │   ├── full.png
 │   ├── full.svg
 │   ├── idea-setup-1.png
 │   ├── idea-setup-2.png
 │   ├── idea-setup-3.png
 │   ├── idea-setup-4.png
 │   ├── idea-setup-5.png
 │   ├── idea-setup-6.png
 │   ├── message-flow-broker-relay.png
 │   ├── message-flow-simple-broker.png
 │   ├── mvc-context-hierarchy.png
 │   ├── mvc-context-hierarchy.svg
 │   ├── mvc.png
 │   ├── mvc-root-context.png
 │   ├── mvc-root-context.svg
 │   ├── overview-ejb.graffle
 │   ├── overview-ejb.png
 │   ├── overview-full.graffle
 │   ├── overview-full.png
 │   ├── overview-remoting.graffle
 │   ├── overview-remoting.png
 │   ├── overview-thirdparty-web.graffle
 │   ├── overview-thirdparty-web.png
 │   ├── oxm-exceptions.graffle
 │   ├── oxm-exceptions.png
 │   ├── prototype.png
 │   ├── remoting.png
 │   ├── remoting.svg
 │   ├── singleton.png
 │   ├── spring-framework.png
 │   ├── spring-mvc-and-webflux-venn.png
 │   ├── spring-overview.graffle
 │   ├── spring-overview.png
 │   ├── spring-overview.svg
 │   ├── spring-overview.vsd
 │   ├── spring.sxd
 │   ├── thirdparty-web.png
 │   ├── thirdparty-web.svg
 │   ├── tx.png
 │   ├── tx_prop_required.png
 │   └── tx_prop_requires_new.png
 ├── index.html
 ├── integration-appendix.html
 ├── integration.html
 ├── languages.html
 ├── overview.html
 ├── pdf
 │   ├── core.pdf
 │   ├── data-access-appendix.pdf
 │   ├── data-access.pdf
 │   ├── images
 │   ├── index.pdf
 │   ├── integration-appendix.pdf
 │   ├── integration.pdf
 │   ├── languages.pdf
 │   ├── overview.pdf
 │   ├── stylesheets
 │   ├── testing.pdf
 │   ├── testing-webtestclient.pdf
 │   ├── tocbot-3.0.2
 │   ├── web.pdf
 │   └── web-reactive.pdf
 ├── stylesheets
 │   ├── asciidoctor-spring.css
 │   └── main.css
 ├── testing.html
 ├── testing-webtestclient.html
 ├── tocbot-3.0.2
 │   ├── styles.css
 │   ├── tocbot.css
 │   ├── tocbot.js
 │   └── tocbot.min.js
 ├── web.html
 └── web-reactive.html

 

@spring-issuemaster

This comment has been minimized.

Copy link
Collaborator

spring-issuemaster commented May 10, 2018

Zhang Jie commented

I am so sorry that I don't know that PR will broke the doc structure on doc server, I just wanted to reduce the file size of docs.zip. The final layout is perfect.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment