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

website restructuring [1/N] #1362

Merged
merged 29 commits into from
Sep 18, 2024
Merged

website restructuring [1/N] #1362

merged 29 commits into from
Sep 18, 2024

Conversation

leogr
Copy link
Member

@leogr leogr commented Sep 4, 2024

What type of PR is this?
/kind cleanup

/kind design

/kind user-interface

/kind content

Any specific area of the project related to this PR?

/area blog
/area documentation

What this PR does / why we need it:

This is the first step of the action plan described in #1365

This PR specifically focuses on reorganizing the first two sections:

  • Getting started (that was already ok, just minor enhancements)
  • Setup (previously Install and Operate)

In the work of moving content to new places, this PR also anticipates the Developer Guide section which, however, needs more work (this will be addressed in followup PRs).

Which issue(s) this PR fixes:

Help with #1365

Special notes for your reviewer:

Some content is still temporary and must be fixed once all the new sections are placed.
Notably, we miss an installation scenario for the non-kernel-instrumentation use case. As a temporary solution, we will forward users to the Plugins section.

@poiana poiana added size/M and removed size/S labels Sep 4, 2024
Comment on lines 50 to 59

If you wish to upgrade Falco to a new version, you need to find the corresponding version in the [Falco Helm Chart repository](https://github.com/falcosecurity/charts/blob/master/charts/falco) (e.g. `4.8.1` is for Falco `0.38.2` ) then run:

```sh
helm upgrade falco -n falco --version 4.8.1
```

{{% pageinfo color="warning" %}}
To avoid any possible disruption, before upgrading to a new version, consult the [Falco Helm chart Breaking Changes page](https://github.com/falcosecurity/charts/blob/master/charts/falco/BREAKING-CHANGES.md).
{{% /pageinfo %}}
Copy link
Member Author

Choose a reason for hiding this comment

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

fyi @alacuku

@poiana poiana added size/XXL and removed size/M labels Sep 5, 2024
@leogr leogr changed the title wip: testing new website structure wip: website restructuring Sep 13, 2024
@leogr leogr changed the title wip: website restructuring wip: website restructuring [1/N] Sep 13, 2024
@LucaGuerra
Copy link
Contributor

I believe there are some missing aliases that can be reached via a Google search:

https://deploy-preview-1362--falcosecurity.netlify.app/docs/install-operate/
https://deploy-preview-1362--falcosecurity.netlify.app/docs/install-operate/third-party/install-tools/

https://www.google.com/search?q=%22falco.org%2Fdocs%2Finstall-operate%22+-site%3Afalco.org

Also, there is a gRPC alias issue I think (too many ../)

@LucaGuerra
Copy link
Contributor

Thanks @leogr ! It's a lot of content and I think the structure makes sense. My main concern is alias consistency because it'll break links from searches, websites, presentations and so forth. The details can always be improved incrementally.

@leogr
Copy link
Member Author

leogr commented Sep 18, 2024

I believe there are some missing aliases that can be reached via a Google search:

https://deploy-preview-1362--falcosecurity.netlify.app/docs/install-operate/ https://deploy-preview-1362--falcosecurity.netlify.app/docs/install-operate/third-party/install-tools/

https://www.google.com/search?q=%22falco.org%2Fdocs%2Finstall-operate%22+-site%3Afalco.org

Also, there is a gRPC alias issue I think (too many ../)

Good catch, thank you! I tried to do my best, but it was still manual and error-prone. Fixing.

leogr and others added 4 commits September 18, 2024 12:20
Co-authored-by: Luca Guerra <[email protected]>
Signed-off-by: Leonardo Grasso <[email protected]>
Co-authored-by: Luca Guerra <[email protected]>
Signed-off-by: Leonardo Grasso <[email protected]>
Co-authored-by: Luca Guerra <[email protected]>
Signed-off-by: Leonardo Grasso <[email protected]>
Co-authored-by: Luca Guerra <[email protected]>
Co-authored-by: Federico Di Pierro <[email protected]>
Signed-off-by: Leonardo Grasso <[email protected]>
content/en/docs/setup/production-enviroments.md Outdated Show resolved Hide resolved
content/en/docs/setup/download.md Outdated Show resolved Hide resolved
leogr and others added 2 commits September 18, 2024 15:11
Co-authored-by: Luca Guerra <[email protected]>
Co-authored-by: Thomas Labarussias <[email protected]>
Signed-off-by: Leonardo Grasso <[email protected]>
Co-authored-by: Thomas Labarussias <[email protected]>
Signed-off-by: Leonardo Grasso <[email protected]>
@leogr leogr requested a review from Issif September 18, 2024 13:39
@leogr leogr changed the title wip: website restructuring [1/N] website restructuring [1/N] Sep 18, 2024
@poiana poiana added the lgtm label Sep 18, 2024
@poiana
Copy link

poiana commented Sep 18, 2024

[APPROVALNOTIFIER] This PR is APPROVED

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

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 0c63b8a into master Sep 18, 2024
6 checks passed
@poiana poiana deleted the refactor/site-structure branch September 18, 2024 16:55
alacuku added a commit to alacuku/charts that referenced this pull request Sep 19, 2024
After the changes made by the following PR to the Falco docs
falcosecurity/falco-website#1362 this
 commit updates a broken link.

Signed-off-by: Aldo Lacuku <[email protected]>
poiana pushed a commit to falcosecurity/charts that referenced this pull request Oct 1, 2024
After the changes made by the following PR to the Falco docs
falcosecurity/falco-website#1362 this
 commit updates a broken link.

Signed-off-by: Aldo Lacuku <[email protected]>
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.

5 participants