Digital Marketplace team manual¶
Useful information for the Digital Marketplace team, including:
History of the service and context for why the service is built as it is.
How we operate our team and our service.
How to run and work on our applications.
What our technical architecture looks like.
Our 2nd Line and Support processes.
Digital Marketplace background
Developing the Digital Marketplace
- Accessing the API
- Adding a new repository
- Application architecture
- Apply to Supply
- Browser and accessibility support
- Environments
- Developer setup
- Shortcut - Digital Marketplace Runner
- Bootstrapping a Mac
- Bootstrapping on Linux
- Running the environment
- Testing the applications
- Ports
- Making requests to your local API instance
- Accessing frontend applications as a single website
- Importing data into your local database
- Elasticsearch
- Using remote versions of services locally
- Configuring Pycharm or IntelliJ IDEA Ultimate
- Libraries and other repositories you will (eventually) need
- Repositories
- Recording decisions on the Digital Marketplace
- Digital Marketplace Runner (‘dmrunner’)
- Nix Environments
- Data model
- Development and deployment process
- Migrating the Digital Marketplace frontend
- Moving data between environments
- URLs
- Users
- Google Analytics
- Load testing
- Automated testing
- Splitting or adding a frontend application
- Database migrations
- Docker strategies
- Frontend assets and tools
- Python typing strategy
- Guidelines for accessing production data and systems
- Managing database backups for the NFT environment
Content and frameworks
- Preparing to add a new framework
- 1 - Make the content
- 2 - Generate service validation schemas and add them to the API
- 3 - Add a supplier declaration validator (optional)
- 4 - Check application email templates
- 5 - Create any new lots
- 6 - Upload legal documents
- 7 - Generate the assessment schemas
- 8 - Create a new search mapping (G-Cloud only)
- 9 - Load test
- 10 - Let’s go!
- Framework lifecycle for developers
- How suppliers apply to a framework
- Framework agreements
- Contract variations
- Adding a new form field type
- Finding content
- Changing content
- Testing supplier applications
- Useful API endpoints for frameworks
Infrastructure
- The Antivirus API
- AWS accounts and access
- AWS Resources
- Code backups
- Database backups
- Domains
- Email integration
- OpenSearch
- Where OpenSearch data is used
- Data that Digital Marketplace gets from OpenSearch
- Where Digital Marketplace finds that data
- Benefits to multi-index single-type model
- Where indexes are described
- What our indexes contain
- How our indexes are named
- How indexes are created
- How indexes are populated
- Aliases
- Jobs
- Catch-up jobs
- Manual (cleanup) jobs
- Checking the OpenSearch version
- Jenkins
- GitHub Actions
- Logging, monitoring and alerting
- Maintenance Mode
- Python environments
- What is PaaS?
- Deploying Digital Marketplace apps to GOV.UK PaaS
- Rate Limiting
- Upgrading backend services
- Session Management
Managing People and Secret Things
2nd Line Runbook
What is this?