substra-documentation icon indicating copy to clipboard operation
substra-documentation copied to clipboard

Published 20 hours ago • verified publisher icon Substra

feat: add Pod Security Standard reference

Open SdgJlbl opened this issue 10 months ago • 4 comments

Fixes FL-1461

SdgJlbl avatar Apr 30 '24 08:04 SdgJlbl

FL-1461 Ensure backend pods comply with the Baseline level of Pod Security Standard

linear[bot] avatar Apr 30 '24 08:04 linear[bot]

I wouldn't put that under API reference as it's not an API reference. To be put maybe under Substra overview?

RomainGoussault avatar May 23 '24 11:05 RomainGoussault

I wouldn't put that under API reference as it's not an API reference. To be put maybe under Substra overview?

Good catch, I would argue to rename API reference to just Reference, or Reference guides then :)

If we stick to diátaxis guidelines, it is definitely more information-oriented than understanding-oriented, so it does not make sense to include it in the explanatory section.

SdgJlbl avatar May 23 '24 12:05 SdgJlbl

I wouldn't put that under API reference as it's not an API reference. To be put maybe under Substra overview?

Good catch, I would argue to rename API reference to just Reference, or Reference guides then :)

If we stick to diátaxis guidelines, it is definitely more information-oriented than understanding-oriented, so it does not make sense to include it in the explanatory section.

Reference guides looks good!

RomainGoussault avatar May 23 '24 12:05 RomainGoussault