How-to Guides
How-to Guides
How-to guides are task-oriented instructions that show you how to solve specific problems. They assume you already have basic knowledge and want to accomplish a particular goal.
What are how-to guides?
How-to guides are focused, practical instructions that:
- Solve specific problems: Address one particular task or challenge
- Assume basic knowledge: Don't explain fundamental concepts
- Are goal-oriented: Focus on accomplishing a specific outcome
- Are concise: Get straight to the point
- Provide working solutions: Include tested code examples
When to use how-to guides
Use how-to guides when you:
- Know what you want to do but need to know how
- Have basic knowledge of platformOS
- Need a practical solution to a specific problem
- Want to see the steps without lengthy explanations
How-to guide structure
Each guide typically includes:
- Brief description: What problem this solves
- Prerequisites: What you need to know or have set up
- Steps: Clear, numbered instructions
- Code examples: Working code you can use
- Related guides: Links to similar or follow-up tasks
Available guides by category
Pages & Layouts
Pages - Creating pages, layouts, error pages, redirects, and more
Assets
Assets - Adding CSS, JavaScript, and static assets
Users
Users - User authentication and management
Records
Records - Working with data persistence and relationships
Properties
Properties - Managing custom properties and uploads
Notifications
Notifications - Sending emails, SMS, and API notifications
Integrations
Integrations - Connecting with third-party services
Identity Providers
Identity Providers - OAuth and authentication providers
Translations
Translations - Multi-language support
Data Management
Data Import/Export - Migrating and managing data
Search - Implementing search functionality
JSON Documents - Working with JSON data
Partner Portal
Domains - Domain and SSL setup
Instances - Instance management
Users - Partner portal user management
Development Tools
pos-cli - Using the command-line interface
CI/CD - Continuous integration and deployment
Not finding what you need?
- New to platformOS? → Start with Tutorials
- Want to understand concepts? → Read Explanations
- Need technical details? → See Reference
This documentation follows the Diataxis framework for organizing technical documentation.