search

Substra / substra-documentation

Documentation of the Substra software
https://docs.substra.org/
Apache License 2.0
21 stars 10 forks source link

feat: add Pod Security Standard reference #418

Closed SdgJlbl closed 5 months ago

SdgJlbl commented 6 months ago

Fixes FL-1461

linear[bot] commented 6 months ago

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

RomainGoussault commented 6 months ago

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

SdgJlbl commented 6 months ago

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.

RomainGoussault commented 6 months ago

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!