Motivation
The Falco website's current navigation structure could be enhanced to better serve users' needs by organizing content based on user intent. This proposal suggests a new navigation pattern that will provide a more intuitive experience, allowing users to find relevant information more efficiently.
The main benefits of this proposed approach are:
- Enhanced user experience with content organized around user goals
- Easier navigation with clear and intuitive paths
- Scalable structure that can grow with the project
Proposed Structure
- Level 1: User Intent
- Organize the primary navigation based on distinct user intents:
- Getting Started: For new users exploring Falco.
- Setup: For users looking to install and configure Falco in different environments.
- This will replace the current Install and Operate
- Advanced Configuration: For users needing to customize or fine-tune their Falco setup.
- Concepts: For users needing to dig deep into specific aspects of Falco (i.e event sources, rules, outputs, plugins, metrics).
- Developer Guide: For developers extending Falco or building on top of it.
- Troubleshooting: For users seeking help and resources.
- Reference: For users needing access to technical documentation, API references, and command guides.
- Contributing: For those who want to contribute to the project.
Note that informative pages or particular relevance may be added to the top navigation (at the bottom) as an exception. This should be limited to 1-3 pages. For instance, we already have Roadmap that should be preserved.
-
Level 2: Alternative Paths for Each Intent
- (example) Provide specific alternative paths or methods for achieving each goal. For example:
- Setup:
- Deploy on Kubernetes
- Deploy as a Container
- Install on a Host
-
Level 3: Steps and Options
- (example) Offer detailed steps and various options under each path. For instance:
- Install on a Host:
- Install
- Configuration
- Upgrade
- Uninstall
Action plan
Website restructuration can be applied in multiple steps by grouping 2-3 top-level sections and working on them. For each section, the content needs to be reviewed and then enhanced (or just moved) to align with its goal. The previous URLs must be preserved (using the alias feature). The subsections of each section will be decided during this stage. Furthermore, we may also remove some content (if it is no longer valid).
Here's the very first PR, #1362, that demonstrates this approach.
Once all sections have been placed, a further step is to review the whole website again for leftovers and inconsistencies.
Motivation
The Falco website's current navigation structure could be enhanced to better serve users' needs by organizing content based on user intent. This proposal suggests a new navigation pattern that will provide a more intuitive experience, allowing users to find relevant information more efficiently.
The main benefits of this proposed approach are:
Proposed Structure
Note that informative pages or particular relevance may be added to the top navigation (at the bottom) as an exception. This should be limited to 1-3 pages. For instance, we already have Roadmap that should be preserved.
Level 2: Alternative Paths for Each Intent
Level 3: Steps and Options
Action plan
Website restructuration can be applied in multiple steps by grouping 2-3 top-level sections and working on them. For each section, the content needs to be reviewed and then enhanced (or just moved) to align with its goal. The previous URLs must be preserved (using the
aliasfeature). The subsections of each section will be decided during this stage. Furthermore, we may also remove some content (if it is no longer valid).Here's the very first PR, #1362, that demonstrates this approach.
Once all sections have been placed, a further step is to review the whole website again for leftovers and inconsistencies.