search

SAP-archive / karydia

Kubernetes Security Walnut
Other
77 stars 10 forks source link

Clean-Up Project and Update Documentation #228

Closed Neumann-Nils closed 4 years ago

Neumann-Nils commented 4 years ago

Description

From my point of view, should the initial readme be short and give new users a basic overview of the project.

Thus, I think we should move the more detailed feature description to the docs folder of the project. Moreover, I don't see the benefit of the "architectural" overview of Karydia, as it does not add any more information to the readme.

I am open to feedback or other opinions on this topic, as it is highly subjective.

Checklist

Before submitting this PR, please make sure:

ionysos commented 4 years ago

It would be great if you could further adjust (all) the markdown files at the docs folder to be well integrated into our GitHub Pages setup. Currently, it's still a little empty. It gets automatically published as soon as it's successfully merged to the master branch. Starting point is index.md and currently the only connected file is the install.md which needs some more content, as well.

Neumann-Nils commented 4 years ago

Sound great. Will definitely do this and also check the other current documents while doing so. Thanks for the feedback.

Neumann-Nils commented 4 years ago

To-Dos:

CLAassistant commented 4 years ago

CLA assistant check
All committers have signed the CLA.

Neumann-Nils commented 4 years ago

Where did you move this contents of the deleted scripts?

The scripts have been moved to the installation folder with the initial introduction of Helm to the project. Currently you can finde the 3 deleted scripts here:

If I remember corretly, we kept these scripts for the installation of the development version. But then decided to adapt the installation process for the integration tests also to use Helm and the scirpts remained as artifacts.