You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@directory.apache.org by Emmanuel Lécharny <el...@gmail.com> on 2020/12/26 16:06:07 UTC
Old version's generated docs on the web site: what do we do ?
Hi !
we have pages refering to the old generated docs (javadoc, xref) for all
of our projects (api, apacheds, fortress, mavibot). Those links are all
broken, but the latest version which has been uploaded to
https://nightlies.apache.org/directory.
The older versions are still available at
https://svn.apache.org/repos/infra/websites/production/directory/content/[project]/gen-docs/[version].
This repo will not change as we now have switched to git, but I guess we
can still refer to it in out site, until we find a better solution ?
Like, moving all the older docs to nightlies.
wdyt ?
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@directory.apache.org
For additional commands, e-mail: dev-help@directory.apache.org
Re: Old version's generated docs on the web site: what do we do ?
Posted by Emmanuel Lécharny <el...@gmail.com>.
On 26/12/2020 20:48, Stefan Seelmann wrote:
> TBH I'm confused about the locations we put the generated docs but also
> the studio userguide.
>
> With the old CMS everything was in SVN.
Well, it was a bit different. Gen docs were pushed into the production
repo, while le other pieces were pushed into the staged repo. When the
site was published, everything was merged into a static site that was
accessible for everyone.
>
> Now the current docs are at https://nightlies.apache.org/, but it seems
> very few projects use that server and it's meant for nightly builds
> rather than serving docs?. I'm a bit afraid that we don't use the right
> tool? Is it the recommended by infra to use it for our purpose?
Infra suggested to use this weird location. Not our choice.
Currently, only the latest revision for each project is stored there.
>
> For old docs archive.apache.org seems right, but can we directly push
> there?
I don't think so. AFAICT, every time we push a new release, the previous
one is moved to archive, so we don't have a hand on what is pushed on
this server. I will ask infra.
> It's also a bit of a pain because we then need to push the docs
> to both, nightlies.a.o and to archive.a.o.
Or we can benefit from teh same mechanism.
>
> Why don't we add the docs to the directory-site git repo directly?
Because it's HUUUUUGE. We are talking about 4Gb of data. Imagine having
to clone this repo...
> Maybe
> I missed a previous discussion. I admit that it would increase the repo
> size, but maybe it's possible to move it to a dedicated branch?
>
> Kind Regards,
> Stefan
>
>
> On 12/26/20 7:25 PM, Emmanuel Lécharny wrote:
>> OTOH, pointing on svn does not seems like a good idea ...
>>
>> May be we could push the old javadocs to
>> https://archive.apache.org/dist/directory/[project]/dist/ ?
>>
>>
>> On 26/12/2020 17:06, Emmanuel Lécharny wrote:
>>> Hi !
>>>
>>>
>>> we have pages refering to the old generated docs (javadoc, xref) for
>>> all of our projects (api, apacheds, fortress, mavibot). Those links
>>> are all broken, but the latest version which has been uploaded to
>>> https://nightlies.apache.org/directory.
>>>
>>> The older versions are still available at
>>> https://svn.apache.org/repos/infra/websites/production/directory/content/[project]/gen-docs/[version].
>>>
>>>
>>> This repo will not change as we now have switched to git, but I guess
>>> we can still refer to it in out site, until we find a better solution
>>> ? Like, moving all the older docs to nightlies.
>>>
>>>
>>> wdyt ?
>>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@directory.apache.org
>> For additional commands, e-mail: dev-help@directory.apache.org
>>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@directory.apache.org
> For additional commands, e-mail: dev-help@directory.apache.org
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@directory.apache.org
For additional commands, e-mail: dev-help@directory.apache.org
Re: Old version's generated docs on the web site: what do we do ?
Posted by Roy Lenferink <rl...@apache.org>.
Now sending this to the dev list as well
Op za 26 dec. 2020 om 20:48 schreef Stefan Seelmann <mail@stefan-seelmann.de
>
> TBH I'm confused about the locations we put the generated docs but also
> the studio userguide.
>
> With the old CMS everything was in SVN.
>
> Now the current docs are at https://nightlies.apache.org/, but it seems
> very few projects use that server and it's meant for nightly builds
> rather than serving docs?. I'm a bit afraid that we don't use the right
> tool? Is it the recommended by infra to use it for our purpose?
Using nightlies.a.o was suggested by infra some time ago; see ticket
INFRA-20849 (including comments):
https://issues.apache.org/jira/browse/INFRA-20849
There were also some thoughts on Slack about this; see the following
messages for that (read the messages further to the top as well):
https://the-asf.slack.com/archives/CBX4TSBQ8/p1600333375445700
>
> For old docs archive.apache.org seems right, but can we directly push
> there? It's also a bit of a pain because we then need to push the docs
> to both, nightlies.a.o and to archive.a.o.
>
> Why don't we add the docs to the directory-site git repo directly?
Maybe
> I missed a previous discussion. I admit that it would increase the repo
> size, but maybe it's possible to move it to a dedicated branch?
This is also a possibility and is up to the project. Having the docs on a
separate branch is surely possible.
For the MINA project there are multiple branches for the generated docs,
but I think it should be possible to use a single branch for this as well
with some RewriteRules in place.
>
> Kind Regards,
> Stefan
>
>
> On 12/26/20 7:25 PM, Emmanuel Lécharny wrote:
> > OTOH, pointing on svn does not seems like a good idea ...
> >
> > May be we could push the old javadocs to
> > https://archive.apache.org/dist/directory/[project]/dist/ ?
> >
> >
> > On 26/12/2020 17:06, Emmanuel Lécharny wrote:
> >> Hi !
> >>
> >>
> >> we have pages refering to the old generated docs (javadoc, xref) for
> >> all of our projects (api, apacheds, fortress, mavibot). Those links
> >> are all broken, but the latest version which has been uploaded to
> >> https://nightlies.apache.org/directory.
> >>
> >> The older versions are still available at
> >>
> https://svn.apache.org/repos/infra/websites/production/directory/content/[project]/gen-docs/[version]
> .
> >>
> >>
> >> This repo will not change as we now have switched to git, but I guess
> >> we can still refer to it in out site, until we find a better solution
> >> ? Like, moving all the older docs to nightlies.
> >>
> >>
> >> wdyt ?
> >>
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@directory.apache.org
> > For additional commands, e-mail: dev-help@directory.apache.org
> >
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@directory.apache.org
> For additional commands, e-mail: dev-help@directory.apache.org
>
>
Re: Old version's generated docs on the web site: what do we do ?
Posted by Stefan Seelmann <ma...@stefan-seelmann.de>.
TBH I'm confused about the locations we put the generated docs but also
the studio userguide.
With the old CMS everything was in SVN.
Now the current docs are at https://nightlies.apache.org/, but it seems
very few projects use that server and it's meant for nightly builds
rather than serving docs?. I'm a bit afraid that we don't use the right
tool? Is it the recommended by infra to use it for our purpose?
For old docs archive.apache.org seems right, but can we directly push
there? It's also a bit of a pain because we then need to push the docs
to both, nightlies.a.o and to archive.a.o.
Why don't we add the docs to the directory-site git repo directly? Maybe
I missed a previous discussion. I admit that it would increase the repo
size, but maybe it's possible to move it to a dedicated branch?
Kind Regards,
Stefan
On 12/26/20 7:25 PM, Emmanuel Lécharny wrote:
> OTOH, pointing on svn does not seems like a good idea ...
>
> May be we could push the old javadocs to
> https://archive.apache.org/dist/directory/[project]/dist/ ?
>
>
> On 26/12/2020 17:06, Emmanuel Lécharny wrote:
>> Hi !
>>
>>
>> we have pages refering to the old generated docs (javadoc, xref) for
>> all of our projects (api, apacheds, fortress, mavibot). Those links
>> are all broken, but the latest version which has been uploaded to
>> https://nightlies.apache.org/directory.
>>
>> The older versions are still available at
>> https://svn.apache.org/repos/infra/websites/production/directory/content/[project]/gen-docs/[version].
>>
>>
>> This repo will not change as we now have switched to git, but I guess
>> we can still refer to it in out site, until we find a better solution
>> ? Like, moving all the older docs to nightlies.
>>
>>
>> wdyt ?
>>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@directory.apache.org
> For additional commands, e-mail: dev-help@directory.apache.org
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@directory.apache.org
For additional commands, e-mail: dev-help@directory.apache.org
Re: Old version's generated docs on the web site: what do we do ?
Posted by Emmanuel Lécharny <el...@gmail.com>.
OTOH, pointing on svn does not seems like a good idea ...
May be we could push the old javadocs to
https://archive.apache.org/dist/directory/[project]/dist/ ?
On 26/12/2020 17:06, Emmanuel Lécharny wrote:
> Hi !
>
>
> we have pages refering to the old generated docs (javadoc, xref) for
> all of our projects (api, apacheds, fortress, mavibot). Those links
> are all broken, but the latest version which has been uploaded to
> https://nightlies.apache.org/directory.
>
> The older versions are still available at
> https://svn.apache.org/repos/infra/websites/production/directory/content/[project]/gen-docs/[version].
>
> This repo will not change as we now have switched to git, but I guess
> we can still refer to it in out site, until we find a better solution
> ? Like, moving all the older docs to nightlies.
>
>
> wdyt ?
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@directory.apache.org
For additional commands, e-mail: dev-help@directory.apache.org