suse / bci-docs Goto Github PK

If you go to https://opensource.suse.com/BCI-docs/ it works. But, if you go to https://opensource.suse.com/bci-docs/ it doesn't. Notice the case difference. I would expect most people who type the URL will use lowercase.

Can we get this fixed? If not to work for both upper and lower to work for just lowercase.

We should include instructions on how the signatures of the binary images as well as the attestations can be verified.

e.g. COSIGN_EXPERIMENTAL=1 cosign verify-attestation --type slsaprovenance --key <keyrile> registry.suse.com/bci/dotnet-runtime:6.0] | jq

There is a lot of passive voice writing in the BCI docs. Passive voice is discouraged for professional writing because:

• It's longer than active voice
• It is indirect and harder to understand
• it feels evasive

For documentation where the main purpose is "how to do what and when" active voice is strongly preferred.

The SUSE colors: https://brand.suse.com/brand-system/color-palette

Currently the documentation uses "BCI", "SUSE BCI" and "SLE BCI". we should stick to one wording and use that consistently. the suggested word to use is "SLE BCI" which highlights that it is a SLE derivative.

We need to document in the "Why SLE BCI?" documentation then what the qualities you can get from SLE BCI (certifications etc when upgrading to the paid offering).

Page: https://opensource.suse.com/bci-docs/documentation/general-purpose-bci/

As there is no straightforward way to install additional dependencies inside the container image, we recommend deploying a project using the BCI-Minimal image only when the final build artifact bundles all dependencies and has no external runtime requirements (like Python or Ruby).

The guidance should be to use BCI-Micro when the final artifact bundles all dependencies and not BCI-Minimal.