You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@pekko.apache.org by "samueleresca (via GitHub)" <gi...@apache.org> on 2023/12/27 14:26:47 UTC
[PR] Updating static assets for [incubator-pekko-site]
samueleresca opened a new pull request, #54:
URL: https://github.com/apache/incubator-pekko-site/pull/54
See: https://github.com/apache/incubator-pekko-sbt-paradox/issues/84
- Moving assets folder from incubator-pekko-sbt-theme to incubator-pekko-site
- Updating content directory.
- Targeting `main`
Change tested in:
- https://github.com/apache/incubator-pekko-site/pull/49
- https://github.com/apache/incubator-pekko-site/pull/51
- https://github.com/apache/incubator-pekko-site/pull/52
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
Re: [PR] Updating static assets for main branch [incubator-pekko-site]
Posted by "pjfanning (via GitHub)" <gi...@apache.org>.
pjfanning commented on PR #54:
URL: https://github.com/apache/incubator-pekko-site/pull/54#issuecomment-1870605527
apologies - that CORS page is already broken - see https://pekko.apache.org/docs/pekko-http/current/common/cors.html
I'm still a bit confused by the output when I build the pekko-http docs because the static artifacts all seem to be in the target folder. Does the sbt-paradox tool download them from the static site and copy them locally?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
Re: [PR] Updating static assets for main branch [incubator-pekko-site]
Posted by "pjfanning (via GitHub)" <gi...@apache.org>.
pjfanning commented on PR #54:
URL: https://github.com/apache/incubator-pekko-site/pull/54#issuecomment-1871103260
I'm not saying it is a bad idea to copy the files during the build but it is also theoretically possible to just link to the full URLs so that we don't deploy multiple copies of the static files (one set per git repo). Is this something that could be considered? I agree that both approaches have pros and cons.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
Re: [PR] Updating static assets for main branch [incubator-pekko-site]
Posted by "samueleresca (via GitHub)" <gi...@apache.org>.
samueleresca commented on PR #54:
URL: https://github.com/apache/incubator-pekko-site/pull/54#issuecomment-1871316810
> I'm not saying it is a bad idea to copy the files during the build but it is also theoretically possible to just link to the full URLs so that we don't deploy multiple copies of the static files (one set per git repo). Is this something that could be considered? I agree that both approaches have pros and cons.
Yes, I think that's possible. At the moment I only moved the static assets defined in `pekko-sbt-paradox` repostiory. There is a whole set of assets that are defined in [paradox-material-theme](https://github.com/jonas/paradox-material-theme).
I have double checked in `incubator-pekko-http` by updating `pekko-sbt-paradox` version: `1.0.0+10-9676045b-SNAPSHOT` and I'm seeing the following asset sub-tree in the `target` folder:
```
assets
│ ├── fonts
│ │ ├── font-awesome.css
│ │ ├── material-icons.css
│ │ └── specimen
│ │ ├── FontAwesome.ttf
│ │ ├── FontAwesome.woff
│ │ ├── FontAwesome.woff2
│ │ ├── MaterialIcons-Regular.ttf
│ │ ├── MaterialIcons-Regular.woff
│ │ └── MaterialIcons-Regular.woff2
│ ├── images
│ │ └── favicon.png
│ ├── javascripts
│ │ ├── application.583bbe55.js
│ │ ├── modernizr.1aa3b519.js
│ │ └── paradox-material-theme.js
│ └── stylesheets
│ ├── application-palette.22915126.css
│ ├── application.451f80e5.css
│ └── paradox-material-theme.css
```
If I use the `1.0.0` (at the moment in main) of `pekko-sbt-paradox`, the sub-tree in the `target` folder is:
```
assets
│ ├── fonts
│ │ ├── font-awesome.css
│ │ ├── material-icons.css
│ │ └── specimen
│ │ ├── FontAwesome.ttf
│ │ ├── FontAwesome.woff
│ │ ├── FontAwesome.woff2
│ │ ├── MaterialIcons-Regular.ttf
│ │ ├── MaterialIcons-Regular.woff
│ │ └── MaterialIcons-Regular.woff2
│ ├── images
│ │ ├── apache-incubator.svg
│ │ ├── favicon.png
│ │ ├── pekko_favicon.png
│ │ └── pekko_logo.png
│ ├── javascripts
│ │ ├── application.583bbe55.js
│ │ ├── groups.js
│ │ ├── modernizr.1aa3b519.js
│ │ └── paradox-material-theme.js
│ └── stylesheets
│ ├── application-palette.22915126.css
│ ├── application.451f80e5.css
│ ├── paradox-material-theme.css
│ └── pekko-theme.css
```
Note that only the following assets are defined in `pekko-sbt-paradox`:
- `pekko-theme.css`
- `groups.js` `paradox-material-theme.js` (already present in `paradox-material-theme`, but overwritten in `incubator-pekko-site`)
- `apache-incubator.svg`, `pekko_favicon.png`, `pekko_logo.png`
While the other assets are coming from the material theme: [paradox-material-theme](https://github.com/jonas/paradox-material-theme).
Since the [paradox-material-theme](https://github.com/jonas/paradox-material-theme) is no longer maintained, I think it makes sense to plan to merge it into `incubator-pekko-sbt-paradox` / `incubator-pekko-site`. See also the discussion in: https://github.com/apache/incubator-pekko-sbt-paradox/issues/34
So I'm seeing some options here:
- (Done in this PR) Move to the CDN the pekko-customized assets. These assets are the ones that we will most likely edit for styling purposes.
- Move the other `paradox-material-theme` assets into `incubator-pekko-site`. This would allow to move faster in case we want to fully diverge from the `paradox-material-theme` style in future.
Let me know if I'm missing something.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
Re: [PR] Updating static assets for main branch [incubator-pekko-site]
Posted by "samueleresca (via GitHub)" <gi...@apache.org>.
samueleresca commented on PR #54:
URL: https://github.com/apache/incubator-pekko-site/pull/54#issuecomment-1871099675
> apologies - that CORS page is already broken - see https://pekko.apache.org/docs/pekko-http/current/common/cors.html
>
> I'm still a bit confused by the output when I build the pekko-http docs because the static artifacts all seem to be in the target folder. Does the sbt-paradox tool download them from the static site and copy them locally?
@pjfanning sbt-paradox include the files in the `target` folder as they are created under the default `_template` route (see [Create local template](https://developer.lightbend.com/docs/paradox/current/customization/theming.html#create-local-templates).
These files are then copied over in the `content` folder and deployed in the CDN
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
Re: [PR] Updating static assets for main branch [incubator-pekko-site]
Posted by "pjfanning (via GitHub)" <gi...@apache.org>.
pjfanning commented on PR #54:
URL: https://github.com/apache/incubator-pekko-site/pull/54#issuecomment-1870542494
Before merging this, I'd like to look at testing a repo like incubator-pekko. I can do that locally. Presumably, if I use the latest snapshot of pekko-sbt-paradox and set the asset.hostname to pekko.staged.apache.org - that I should get a usable set of pages.
If this works out, we can merge this. We can then reset the asf-staging branch to match main.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
Re: [PR] Updating static assets for main branch [incubator-pekko-site]
Posted by "samueleresca (via GitHub)" <gi...@apache.org>.
samueleresca merged PR #54:
URL: https://github.com/apache/incubator-pekko-site/pull/54
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
Re: [PR] Updating static assets for main branch [incubator-pekko-site]
Posted by "pjfanning (via GitHub)" <gi...@apache.org>.
pjfanning commented on PR #54:
URL: https://github.com/apache/incubator-pekko-site/pull/54#issuecomment-1870585034
I built pekko-http docs locally with pekko-sbt-paradox 1.0.0+9-1bc182b6-SNAPSHOT and there was an issue with the Java/Scala tabs. On the CORS page, I get this:
<img width="709" alt="image" src="https://github.com/apache/incubator-pekko-site/assets/11783444/e4d62691-443b-4132-9ea7-440c3ba03404">
This should be displayed with 2 tabs - one for Scala, one for Java.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
Re: [PR] Updating static assets for main branch [incubator-pekko-site]
Posted by "pjfanning (via GitHub)" <gi...@apache.org>.
pjfanning commented on PR #54:
URL: https://github.com/apache/incubator-pekko-site/pull/54#issuecomment-1873011934
@samueleresca I recreated asf-staging from main branch - losing the forked history. If you need to preserve anything from that forked history then it would be good if you could create a branch on your samueleresca fork of this repo.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org