We've let the quickstart guide get overgrown. This PR makes it much quicker.
I moved a lot of content into separate files. I don't want to de-emphasize anything, but putting everything in one file simply does not scale and it seriously compromises the focus of what is supposed to be an approachable starting point for people coming to the project. I have tried to include pointers to the new documents in every relevant section. I don't want any of the great work people have already done on the guide to be lost.
I ditched our old four-step structure (which we weren't really following anyway) and opted for a different four-step structure, which I think is a bit simpler. Now the quickstart guide focuses on installation, basic unencrypted workloads, encryption, singing, and attestation using the generic KBS. Everything else has been moved to other files.
Hopefully I'm not the only one who thinks this is an improvement because it was a huge pain. I think this should hold us over until we get serious about having a documentation website. lmk what you think.
fitzthum
commented
1 year ago
We've let the quickstart guide get overgrown. This PR makes it much quicker.
I moved a lot of content into separate files. I don't want to de-emphasize anything, but putting everything in one file simply does not scale and it seriously compromises the focus of what is supposed to be an approachable starting point for people coming to the project. I have tried to include pointers to the new documents in every relevant section. I don't want any of the great work people have already done on the guide to be lost.
I ditched our old four-step structure (which we weren't really following anyway) and opted for a different four-step structure, which I think is a bit simpler. Now the quickstart guide focuses on installation, basic unencrypted workloads, encryption, singing, and attestation using the generic KBS. Everything else has been moved to other files.
Hopefully I'm not the only one who thinks this is an improvement because it was a huge pain. I think this should hold us over until we get serious about having a documentation website. lmk what you think.