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.

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

new(docs): update getting started pages #1333

Merged

Conversation

LucaGuerra
Copy link
Contributor

@LucaGuerra LucaGuerra commented Jun 24, 2024

What type of PR is this?

Uncomment one (or more) /kind <> lines:

/kind content

Any specific area of the project related to this PR?

Uncomment one (or more) /area <> lines:

/area documentation

What this PR does / why we need it:

Lately we have worked a lot to improve Falco's installation experience and remove some manual configuration that you had to specify the first time you used it. I believe it's time to make this work shine in the "Getting Started" page. Instead of relying on reproducible environments that however would require you to have VirtualBox or other similar things installed, I would propose offering the simplest commands to start Falco, along with a quick path to see your first event and write your first rule.

I don't think, however, that the guide that uses VirtualBox should be entirely thrown away but it's not the first one that we should suggest IMO.

This PR is here to discuss if we agree with that, and then I can complete the missing parts and/or we can proceed adding other sections

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Copy link
Member

@leogr leogr left a comment

Choose a reason for hiding this comment

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

Great job @LucaGuerra 👏

I left a few suggestions (just nitpicking 👼 ), but overall I love the new shape of the getting started section.

Let me know when you remove the "WIP", and I will give a second look

🙏

content/en/docs/getting-started/docker-quickstart.md Outdated Show resolved Hide resolved
content/en/docs/getting-started/docker-quickstart.md Outdated Show resolved Hide resolved
content/en/docs/getting-started/docker-quickstart.md Outdated Show resolved Hide resolved
content/en/docs/getting-started/docker-quickstart.md Outdated Show resolved Hide resolved
content/en/docs/getting-started/docker-quickstart.md Outdated Show resolved Hide resolved
content/en/docs/getting-started/kubernetes-quickstart.md Outdated Show resolved Hide resolved
content/en/docs/getting-started/kubernetes-quickstart.md Outdated Show resolved Hide resolved
content/en/docs/getting-started/kubernetes-quickstart.md Outdated Show resolved Hide resolved
content/en/docs/getting-started/kubernetes-quickstart.md Outdated Show resolved Hide resolved
content/en/docs/getting-started/kubernetes-quickstart.md Outdated Show resolved Hide resolved
@LucaGuerra LucaGuerra force-pushed the update/faster-getting-started-page branch from b87fd1a to 144c512 Compare July 16, 2024 15:27
@LucaGuerra LucaGuerra force-pushed the update/faster-getting-started-page branch from 144c512 to 70f801a Compare July 16, 2024 15:28
@LucaGuerra LucaGuerra changed the title proposal / wip: new(docs): update getting started pages new(docs): update getting started pages Jul 16, 2024
@LucaGuerra
Copy link
Contributor Author

I made additional changes, completed the k8s section and added back the Linux (w/ Vagrant) section.
@leogr @Issif I think it's ready for review, please let me know what you think!

Copy link
Member

@leogr leogr left a comment

Choose a reason for hiding this comment

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

Just found a typo (now fixed), otherwise LGTM.

@Issif wdyt?

content/en/docs/getting-started/linux-quickstart.md Outdated Show resolved Hide resolved
@poiana
Copy link

poiana commented Jul 24, 2024

LGTM label has been added.

Git tree hash: 06e56704098c29f142d0888cd1851d43c0c2bccd

@poiana
Copy link

poiana commented Jul 24, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: leogr, LucaGuerra

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@poiana poiana merged commit 100acd4 into falcosecurity:master Jul 24, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants