Document Time Unit of max.stale property about bndtools.github.io

[pkriens]

I like the idea to put links in. It seems to only have advantages. It makes the bndtools page easier to digest and it has a single definition.

[chrisrueger]

@spacehorst just checking: On this page https://bndtools.org/manual/repositories-view.html there is a slightly different explaination

The time (in seconds) a cached entry stays in

than on https://bnd.bndtools.org/plugins/osgirepo.html

Bnd has it’s own download cache. Max stale configures for how long the downloaded index file stays in the internal download cache

Admittetly both should be in sync, but just asking both are answering your question. If yes, then we could sync them.

[spacehorst]

I think the documentation should be true, precise, simple and should not make assumptions about supplements at different locations. So if it is going to be reworked anyway, I suggest the following merged documentation for both places:

Bnd has it’s own download cache. Max stale configures for how many seconds the downloaded index file stays in the internal download cache.

[chrisrueger]

@spacehorst thanks a lot. I will add your suggestion to both places.

I agree it is not optimal to have it in two places - maybe we can improve this in the future.

[chrisrueger]

@pkriens what's your opinion? https://bndtools.org/manual/repositories-view.html then specific repo pages in the bnd manual are kinda redundant.

One idea could be:

• keep https://bndtools.org/manual/repositories-view.html but remove the parameter tables
• add a link to each repository pointing to the page in bnd manual which has the parameters.

[chrisrueger]

Thanks. I will update the PR for the website later

[chrisrueger]

I like the idea to put links in. It seems to only have advantages. It makes the bndtools page easier to digest and it has a single definition.

@pkriens I have create two PR's which go hand in hand.
I think I would need your help here. I think I found some inconsistencies, and I also tried merging some tables.
Would be good to have 2nd pair of eyes.

• bndtools/bnd#6068
• #169

Especially the two TODOs here and here.

Update: I resolved (removed) the TODOs, the way I think it is correct. So you don't see the TODOs anymore, except in the commit history.

Maybe can do it in a documentation zoom call like last week.