Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: change directory structure, overview content in each section an… #3641

Merged
merged 5 commits into from
Nov 2, 2023
Merged

docs: change directory structure, overview content in each section an… #3641

merged 5 commits into from
Nov 2, 2023

Conversation

AnaisUrlichs
Copy link
Contributor

Changes

  • Add usage section for CLI and Kubernetes
  • Rewrite existing overview sections -- namely, for events and policies
  • Add Overview page to docs section where there was none
  • Resolve broken links across docs

TODO:

@AnaisUrlichs AnaisUrlichs requested a review from itaysk October 31, 2023 12:59
@AnaisUrlichs AnaisUrlichs changed the title docs: change directory structure, overview content in each section an… WIP: docs: change directory structure, overview content in each section an… Oct 31, 2023
@AnaisUrlichs AnaisUrlichs requested a review from geyslan October 31, 2023 16:14
geyslan
geyslan reviewed Oct 31, 2023
View reviewed changes
mkdocs.yml Outdated Show resolved Hide resolved
geyslan
geyslan reviewed Oct 31, 2023
View reviewed changes
docs/docs/install/config/kubernetes.md
@@ -17,22 +17,20 @@ metadata:
data:
config.yaml: |-
cache:
type: mem
size: 512
- cache-type=mem
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These must be the new structured.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

but that is in your PR, no?

Copy link
Member

@geyslan geyslan Nov 1, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mine (structured config) was already merged. So you're rolling it back hehe.

geyslan
geyslan reviewed Oct 31, 2023
View reviewed changes
docs/docs/flags/containers.1.md Outdated
@@ -1,7 +1,7 @@
---
title: TRACEE-CRI
title: TRACEE-CRS
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Must be CRI.

itaysk
itaysk reviewed Oct 31, 2023
View reviewed changes
docs/docs/events/index.md Outdated Show resolved Hide resolved
docs/docs/events/index.md Show resolved Hide resolved
docs/docs/events/index.md Show resolved Hide resolved
docs/docs/events/index.md Outdated Show resolved Hide resolved
docs/docs/events/index.md Outdated Show resolved Hide resolved
docs/docs/install/config/cli.md Outdated Show resolved Hide resolved
docs/docs/install/config/cli.md Outdated Show resolved Hide resolved
docs/docs/install/config/cli.md Show resolved Hide resolved
docs/docs/outputs/index.md Outdated Show resolved Hide resolved
docs/docs/policies/rules.md Outdated Show resolved Hide resolved
@AnaisUrlichs AnaisUrlichs force-pushed the docs-restructure-3607 branch from 95383a4 to fe3026b Compare November 1, 2023 11:22
@AnaisUrlichs AnaisUrlichs force-pushed the docs-restructure-3607 branch from fe3026b to 21b5f37 Compare November 1, 2023 11:31
itaysk
itaysk approved these changes Nov 1, 2023
View reviewed changes
Copy link
Collaborator

@itaysk itaysk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍👍

@itaysk
Copy link
Collaborator

itaysk commented Nov 1, 2023

For a future PR

the install/config section should probably have an index.md that shows the different configuration options (irrespective of how to apply it which is in the cli/kuberntes pages).

@AnaisUrlichs AnaisUrlichs changed the title WIP: docs: change directory structure, overview content in each section an… docs: change directory structure, overview content in each section an… Nov 2, 2023
@itaysk itaysk merged commit 8733779 into aquasecurity:main Nov 2, 2023
1 check passed
This was referenced Nov 2, 2023
Merged
Merged
itaysk added a commit that referenced this pull request Nov 2, 2023
@itaysk
docs: fixes and changes after #3641 (#3655)
9ca3bd3 
* rename deep-dive to advanced

* move forensics

* move data sources

* redo config section

* healthz

* redo container engines
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@itaysk itaysk itaysk approved these changes

@geyslan geyslan Awaiting requested review from geyslan

Assignees

@AnaisUrlichs AnaisUrlichs

Labels
kind/documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@AnaisUrlichs @itaysk @geyslan @rafaeldtinoco