Background orientation
Setup and configuration
- How to establish the local development environment
- How to use EditorConfig for consistent whitespace handling and coding-style
Getting started
Reference documentation
- Where is API reference documentation
- How to configure the generation of API documentation
- How to use APIs
- Explain continuously built reference environments
Development tips
- Where is developer documentation located
- Explain the FOLIO permissions system
- Explain CQL string matching
- Explain DB schema and performance issues
- Explain internationalization and localization
- Explain international date and time handling
- Explain country codes
- How to install new module to platform and reference environments
- How to determine which module handles which interface and endpoint
- How to get started with Rancher environment
- How to integrate code coverage reports with SonarQube
- How to specify which Jenkins build image for CI
- How to investigate Jenkins build logs
- How to obtain reference environment module logs
Development management
- Explain the release procedures
- How to request GitHub user or team access
- How to raise a DevOps Jira ticket
- How to archive a GitHub repository
- Where is project roadmap and other management documentation
- How to attend weekly team meetings
- How to create a new FAQ document
Testing
Developer documentation
Managing and creating documentation for this dev.folio.org site.
- Where is developer documentation located
- How to find new and updated developer documentation
- How to contribute to developer documentation
- How to create a new document
- How to create a new Tutorial set of documents
- How to create a new FAQ document
Other topics
Not yet categorised.