Skip to content

Commit 6ea41ec

Browse files
committed
refactor(spp_branding_kit): reorganize documentation structure
- Remove README.md to follow standard module documentation pattern - Add DESCRIPTION.md in readme folder following spp_area pattern - Document module purpose, dependencies, functionality, and configuration - Include dependency on theme_openspp_muk module - Maintain comprehensive module documentation in proper location
1 parent b9e4829 commit 6ea41ec

File tree

2 files changed

+83
-243
lines changed

2 files changed

+83
-243
lines changed

spp_branding_kit/README.md

Lines changed: 0 additions & 243 deletions
This file was deleted.
Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# OpenSPP Branding Kit
2+
3+
This document describes the **OpenSPP Branding Kit** module, which provides comprehensive debranding and rebranding functionality for Odoo 17 installations used within the OpenSPP ecosystem.
4+
5+
## Purpose
6+
7+
The **OpenSPP Branding Kit** module is designed to:
8+
9+
* **Apply OpenSPP Branding**: Replace removed Odoo branding with OpenSPP-specific branding elements, including logos, colors, text, and system information.
10+
* **Control Telemetry and External Communications**: Provide administrators with control over telemetry data collection and external service communications.
11+
* **Hide Paid Applications**: Optionally filter out enterprise and paid Odoo applications from the Apps menu to focus on open-source modules.
12+
* **Customize System Behavior**: Offer configuration options for debug mode access, system naming, documentation URLs, and support links.
13+
14+
## Dependencies and Integration
15+
16+
1. **Odoo 17 Core**: This module is built specifically for Odoo 17 and utilizes its standard extension mechanisms.
17+
18+
2. **OpenSPP Muk Theme ([theme_openspp_muk](theme_openspp_muk))**: Depends on the OpenSPP Muk theme module which provides the base visual theme and styling framework for the OpenSPP platform.
19+
20+
21+
## Additional Functionality
22+
23+
* **Configuration Management ([ir.config_parameter](ir.config_parameter))**:
24+
* Introduces system-wide configuration parameters with the `openspp.*` prefix for centralized branding control.
25+
* Provides settings for system name, documentation URLs, support links, and telemetry endpoints.
26+
* Enables toggle options for features like hiding paid apps and restricting debug mode access.
27+
28+
* **Module Filtering ([ir.module.module](ir.module.module))**:
29+
* Implements intelligent filtering of paid applications (OEEL and OPL licensed modules) from the Apps menu.
30+
* Maintains visibility of paid modules in administrative views while hiding them from the standard Apps interface.
31+
* Provides helper methods for counting and filtering paid applications.
32+
33+
* **Web Interface Customization**:
34+
* Customizes the web client to enforce debug mode restrictions based on user permissions.
35+
* Provides custom routes for OpenSPP-specific information pages.
36+
* Modifies session information to include OpenSPP branding data.
37+
* Implements telemetry redirection to OpenSPP endpoints when enabled.
38+
39+
* **Company Branding Updates ([res.company](res.company))**:
40+
* Automatically updates company information with OpenSPP branding during module installation.
41+
* Sets default report headers and footers with OpenSPP information.
42+
* Updates company website references to OpenSPP URLs.
43+
44+
* **User Interface Enhancements**:
45+
* Customizes login page styling with OpenSPP branding.
46+
* Modifies backend interface colors and styling.
47+
* Updates user menu items and removes Odoo-specific links.
48+
* Provides custom email signature templates.
49+
50+
* **Security and Privacy Features**:
51+
* Disables unnecessary telemetry and external communications by default.
52+
* Removes promotional content and enterprise upselling elements.
53+
* Provides administrator-only debug mode option for enhanced security.
54+
* Implements proper permission controls for branding configuration.
55+
56+
## Module Components
57+
58+
* **Controllers**: Custom HTTP routes for OpenSPP-specific pages and version information.
59+
* **Models**: Extensions to core Odoo models for branding customization.
60+
* **Data Files**: XML configuration for default parameters and company settings.
61+
* **Views**: XML templates for UI customization across backend, login, and report interfaces.
62+
* **Static Assets**: CSS, JavaScript, and image files for visual branding.
63+
* **Tests**: Comprehensive test suite ensuring proper functionality and coverage.
64+
65+
## Installation Hooks
66+
67+
* **Post-Installation Hook**: Automatically applies initial branding configuration, disables Odoo promotional elements, and updates company information.
68+
* **Uninstall Hook**: Cleanly removes OpenSPP configuration parameters while preserving user data.
69+
70+
## Configuration Options
71+
72+
The module provides various configuration parameters that can be adjusted through the Settings interface or directly via system parameters:
73+
74+
* `openspp.system_name`: Custom system name displayed throughout the interface
75+
* `openspp.hide_paid_apps`: Toggle to hide paid applications from the Apps menu
76+
* `openspp.debug_admin_only`: Restrict debug mode access to administrators only
77+
* `openspp.telemetry_enabled`: Enable or disable telemetry data collection
78+
* `openspp.documentation_url`: Custom documentation URL for help links
79+
* `openspp.support_url`: Custom support URL for assistance
80+
81+
## Conclusion
82+
83+
The **OpenSPP Branding Kit** module provides a complete solution for transforming an Odoo 17 installation into a fully branded OpenSPP platform. It ensures consistent branding across all interfaces while maintaining system functionality and providing administrators with granular control over branding and behavior settings. The module's modular architecture and adherence to Odoo best practices ensure compatibility with future updates and seamless integration with other OpenSPP modules.

0 commit comments

Comments
 (0)