apache / pekko-http

The Streaming-first HTTP server/module of Apache Pekko
https://pekko.apache.org/
Apache License 2.0
149 stars 36 forks source link

[docs] the link to the incubator svg in our footer is broken on some pages #482

Closed pjfanning closed 4 months ago

pjfanning commented 6 months ago

https://pekko.apache.org/docs/pekko-http/current/introduction.html is fine it links to https://pekko.apache.org/docs/pekko-http/current/assets/images/apache-incubator.svg

https://pekko.apache.org/docs/pekko-http/current/client-side/http2.html has wrong link it links to https://pekko.apache.org/docs/pekko-http/current/client-side/assets/images/apache-incubator.svg

Note the stray /client-side in the image URL.

This looks like a general problem when we nest our docs - that the link to the apache-incubator.svg in the footer includes a stray dir in the path. The following link is for a doc generated in the incubator-pekko repo.

https://pekko.apache.org/docs/pekko/current/discovery/index.html links to https://pekko.apache.org/docs/pekko/current/discovery/assets/images/apache-incubator.svg

pjfanning commented 6 months ago

@samueleresca this might be a pre-existing issue but is there a chance that the recent changes to our pekko-sbt-paradox and pekko-site setup could be an issue?

pjfanning commented 6 months ago

I suspect that this is a long running issue. I tried building with the pekko-http docs locally using the latest pekko-sbt-paradox snapshot but had the same issue.

I would like to change the link in footer.st to be an absolute URL to avoid the need to worry about the nesting of the docs.

Just link to https://pekko.apache.org/assets/images/apache-incubator.svg

samueleresca commented 6 months ago

Yes the problem is that the path is relative in the source: assets/images/apache-incubator.svg.

I suspect that this is a long running issue. I tried building with the pekko-http docs locally using the latest pekko-sbt-paradox snapshot but had the same issue.

I would like to change the link in footer.st to be an absolute URL to avoid the need to worry about the nesting of the docs.

Just link to https://pekko.apache.org/assets/images/apache-incubator.svg

Could you please double check? I tried to update pekko-sbt-paradox at the 1.0.0+10-9676045b-SNAPSHOT snapshot locally and it seems producing the right URL for the image in the HTML source: https://pekko.apache.org/assets/images/apache-incubator.svg after building the doc with sbt docs/paradox:

<img src="https://pekko.apache.org/assets/images/apache-incubator.svg" alt="Apache Incubator logo" id="incubator__logo">

If the local build is working correctly I don't think incubator-pekko-sbt-paradox/#101 is needed

pjfanning commented 6 months ago

I will retry 1.0.0+10-9676045b-SNAPSHOT but it did not seem to work as expected for me. I will double check.

pjfanning commented 6 months ago

@samueleresca I tried that again and it worked. I'll close my PR.

samueleresca commented 6 months ago

@pjfanning Do we have any plan for kicking off the release of pekko-sbt-paradox? I can help in case

pjfanning commented 6 months ago

My hope is that we can win a vote to become a TLP. We would then need to remove the Incubator references and release the paradox code. Even if we fail, we should do a paradox release - I just want to wait to see if can win the vote first.