trivy icon indicating copy to clipboard operation
trivy copied to clipboard

docs: Updating documentation structure and content in the tutorial section

Open AnaisUrlichs opened this issue 2 years ago • 7 comments

Description

  • Converting the Quick-start section into tutorials
  • Moving integrations into the tutorials section
  • adding three tutorials; Trivy Kubernetes, GitOps, and installing Trivy into ovh cloud
  • I made the installation section more visible by moving it to the main index.md

Checklist

  • [x] I've read the guidelines for contributing to this repository.
  • [x] I've followed the conventions in the PR title.
  • [ ] I've added tests that prove my fix is effective or that my feature works.
  • [x] I've updated the documentation with the relevant information (if needed).
  • [ ] I've added usage information (if the PR introduces new options)
  • [ ] I've included a "before" and "after" example to the description (if the PR is a user interface change).

AnaisUrlichs avatar Jun 15 '22 19:06 AnaisUrlichs

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
2 out of 3 committers have signed the CLA.

:white_check_mark: AnaisUrlichs
:white_check_mark: knqyf263
:x: Anais Urlichs


Anais Urlichs seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

CLAassistant avatar Jun 15 '22 19:06 CLAassistant

@itaysk @knqyf263 could you please check the PR again?

AnaisUrlichs avatar Jul 04 '22 09:07 AnaisUrlichs

@knqyf263 could you please review and merge the docs with the next release or similar?

AnaisUrlichs avatar Jul 26 '22 14:07 AnaisUrlichs

I don't have a strong opinion. I'm ok if Itay approves it. One thing to note is that we added some updates on our doc such as SBOM attestation. We need to make sure all the changes are reflected to this PR.

knqyf263 avatar Jul 26 '22 16:07 knqyf263

@knqyf263 I've merged the main branch into this one in one of my last commits

AnaisUrlichs avatar Jul 27 '22 08:07 AnaisUrlichs

@knqyf263 just merged main into it

AnaisUrlichs avatar Aug 03 '22 12:08 AnaisUrlichs

@AnaisUrlichs Thanks. @itaysk Would you review this PR?

knqyf263 avatar Aug 03 '22 13:08 knqyf263

@itaysk @knqyf263 I made several changes based on your comments

  • removed the Kubernetes tutorial from the tutorials section and added it to the community tutorials
  • made it clearer what community tutorials are and where they go in the docs
  • clarified what CKS stands for with a link
  • merged in latest changes from main

AnaisUrlichs avatar Aug 14 '22 13:08 AnaisUrlichs

consider adding tekton tutorial: https://www.redhat.com/architect/cicd-pipeline-openshift-tekton

itaysk avatar Aug 15 '22 11:08 itaysk

@knqyf263 could you please have another look 🙃

AnaisUrlichs avatar Sep 05 '22 10:09 AnaisUrlichs

@AnaisUrlichs Would you resolve conflicts and merge the main branch? Then I hope we can merge this PR🤞

knqyf263 avatar Sep 13 '22 11:09 knqyf263

@knqyf263 merged main and resolved conflicts

AnaisUrlichs avatar Sep 14 '22 10:09 AnaisUrlichs

I saw several rendering errors and fixed them. Also, I added some small changes.

knqyf263 avatar Sep 15 '22 06:09 knqyf263

@AnaisUrlichs Do you have two accounts? Looks like one of them has not signed CLA yet. https://github.com/aquasecurity/trivy/pull/2333#issuecomment-1156868203

knqyf263 avatar Sep 15 '22 07:09 knqyf263