Welcome to OLCMS documentation!

Intended audience

This guide is mainly for technical people that want to re-use our solution.

Contents:

• Glossary
• Contributing Guide
  • How to configure developer environment
  • Developer environment features
  • Common developer tasks
  • Not so common developement tasks
  • How to add a new feature
  • What to test
• Deploy
  • Third party system you’ll need to configure
  • VM requirements
  • Building images
  • Prepare environment variables
  • Deployment
  • Docker compose file we use
• Content management system
  • Markdown
  • CMS Pages
  • Page Blocks
  • Main page links
• CSS stylesheets
  • Per-discipline styling
• Uploading files how does it work
  • Rationale
  • Python api
  • HTTP API
  • How to handle file updates
• Forum integration
  • Our deployment practices
  • Integration points
• Language switching
  • Making this application translatable
  • How to translate this application
  • How to add new languages
  • How does language detection work
• Permissions
• How does indexing work
  • Indexing in dev environment
  • Indexing in prod environment
• How to add new fields
  • How to add field searchable by full text search
  • How to add field searchable as an extra field
  • How to add ranked field
• Simulation resources
  • Pluggability
• Tagging system
  • Domains
  • Tags
• ContentItem Verification
  • How does content verification work
  • What changes with unverified content
  • How to verify content
• www-base repository
• Obtaining youtube credentials
  • Introduction
  • What credentials do you need
  • Obtaining youtube oauth2 key
  • Obtain refresh token
  • Create a playlist and obtain playlist ID
  • Store permissions in environment variables
• CMS End user documentation
  • Obtaining permissions
  • Adding new CMS page
  • Add new link to menu

Indices and tables

• Index
• Module Index
• Search Page