You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@pekko.apache.org by "pjfanning (via GitHub)" <gi...@apache.org> on 2023/02/13 11:34:32 UTC
[GitHub] [incubator-pekko] pjfanning opened a new issue, #179: change location where we store nightlies docs
pjfanning opened a new issue, #179:
URL: https://github.com/apache/incubator-pekko/issues/179
It might be useful to change the directory structure we store the docs in when rsync to nightlies - so that URLs more closely match those traditionally used in the docs.akka.io site.
The URL will start https://nightlies.apache.org/pekko but the rest of the path is under our control.
https://nightlies.apache.org/pekko/pekko-docs-main/docs/typed/actors.html -- could be changed to https://nightlies.apache.org/pekko/docs/pekko/current/typed/actors.html
After `docs`, the path elements are `pekko` (this is `pekko-http` for http docs, etc.) and `current` for the version.
--
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.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
[GitHub] [incubator-pekko] jrudolph closed issue #179: change location where we store nightlies docs
Posted by "jrudolph (via GitHub)" <gi...@apache.org>.
jrudolph closed issue #179: change location where we store nightlies docs
URL: https://github.com/apache/incubator-pekko/issues/179
--
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
[GitHub] [incubator-pekko] pjfanning commented on issue #179: change location where we store nightlies docs
Posted by "pjfanning (via GitHub)" <gi...@apache.org>.
pjfanning commented on issue #179:
URL: https://github.com/apache/incubator-pekko/issues/179#issuecomment-1427793981
@jrudolph @mdedetrich would this change make sense? We could then redirect pekko.apache.org to the https://nightlies.apache.org/pekko site using a .htaccess file.
--
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
[GitHub] [incubator-pekko] jrudolph commented on issue #179: change location where we store nightlies docs
Posted by "jrudolph (via GitHub)" <gi...@apache.org>.
jrudolph commented on issue #179:
URL: https://github.com/apache/incubator-pekko/issues/179#issuecomment-1427876085
First of all, let's not optimize paths on the nightly server for public consumption. If we have to serve using redirects from this domain, it's just a bandaid we should try to get rid of. In any case, we should never point any public links to it (but we might be required to use `.htaccess` to serve documentation).
That said, we should just choose a folder layout that helps organizing all the bits in the best way. I assumed we would get a top-level folder for all subprojects but I might have misunderstood that. The current layout is modeled after what flink does but they don't have many subprojects so deviating from that makes sense.
The `current` folder (or symlink) in Akka does not point to the latest snapshot but to the latest released public version, so if we are for consistency we shouldn't be using `current` for snapshots. Maybe we could organize it like this:
* pekko/docs/pekko/snapshot-main/{docs,api,japi}: published from main branch of pekko
* pekko/docs/pekko-http/snapshot-main/{docs,api,japi}: published from main branch of pekko-http
* etc
* pekko/docs/pekko/snapshot-release-1.0/{docs,api,japi}: published from release 1.0 branch of pekko
* (if necessary) pekko/docs/pekko/1.0.0/{docs,api,japi}: released version of docs for public 1.0.0 version
* (if necessary) pekko/docs/pekko/current/: link to the latest released version of docs
We should still strive to serve public release docs from the proper domain and it's probably totally possible to use the git based infra for that.
--
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
[GitHub] [incubator-pekko] mdedetrich commented on issue #179: change location where we store nightlies docs
Posted by "mdedetrich (via GitHub)" <gi...@apache.org>.
mdedetrich commented on issue #179:
URL: https://github.com/apache/incubator-pekko/issues/179#issuecomment-1427795696
I am fine with this but I may be 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
[GitHub] [incubator-pekko] jrudolph commented on issue #179: change location where we store nightlies docs
Posted by "jrudolph (via GitHub)" <gi...@apache.org>.
jrudolph commented on issue #179:
URL: https://github.com/apache/incubator-pekko/issues/179#issuecomment-1446451092
AFAICS finished in #180.
--
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
[GitHub] [incubator-pekko] pjfanning commented on issue #179: change location where we store nightlies docs
Posted by "pjfanning (via GitHub)" <gi...@apache.org>.
pjfanning commented on issue #179:
URL: https://github.com/apache/incubator-pekko/issues/179#issuecomment-1427877972
We have one https://nightlies.apache.org/pekko site for our whole project. The pekko, pekko-http, etc. docs would all be uploaded there.
--
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
[GitHub] [incubator-pekko] mdedetrich commented on issue #179: change location where we store nightlies docs
Posted by "mdedetrich (via GitHub)" <gi...@apache.org>.
mdedetrich commented on issue #179:
URL: https://github.com/apache/incubator-pekko/issues/179#issuecomment-1427883853
> pekko/docs/pekko/snapshot-release-1.0/{docs,api,japi}: published from release 1.0 branch of pekko
Is this necessary? To me just having snapshots from `main` should be enough because I don't see how useful granular release branch snapshots would be to users.
> (if necessary) pekko/docs/pekko/current/: link to the latest released version of docs
I would classify this as necessary because its very useful to have a consistent reference to the latest released versions
--
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
[GitHub] [incubator-pekko] pjfanning commented on issue #179: change location where we store nightlies docs
Posted by "pjfanning (via GitHub)" <gi...@apache.org>.
pjfanning commented on issue #179:
URL: https://github.com/apache/incubator-pekko/issues/179#issuecomment-1427883425
I'm happy with all of @jrudolph's suggestions. pekko.apache.org could be pointed at the snapshot-main docs on nightlies site as a short term convenience. When we do a 1.0.0 release, we will probably change so that pekko.apache.org site does not use the artifacts on the nightlies site (Flink do use the nightlies site, even to serve their release docs -- but I think this is untidy - and Incubator PMC might also think is untidy if we went this route for the post-release pekko site).
--
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
[GitHub] [incubator-pekko] jrudolph commented on issue #179: change location where we store nightlies docs
Posted by "jrudolph (via GitHub)" <gi...@apache.org>.
jrudolph commented on issue #179:
URL: https://github.com/apache/incubator-pekko/issues/179#issuecomment-1429479835
> > (if necessary) pekko/docs/pekko/current/: link to the latest released version of docs
>
> I would classify this as necessary because its very useful to have a consistent reference to the latest released versions.
Yes, sure, but not necessarily on the nightlies domain.
> > pekko/docs/pekko/snapshot-release-1.0/{docs,api,japi}: published from release 1.0 branch of pekko
>
> Is this necessary? To me just having snapshots from `main` should be enough because I don't see how useful granular release branch snapshots docs would be to users.
True, depends a bit on how long we will be supporting release branches.
--
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