docs: rewrite README with structured overview and quick start guide
Replaces the minimal project description with a comprehensive README including a component overview table, quick start instructions, common Ansible operations, and links to detailed documentation. Aligns with Red Panda Approval™ standards.
This commit is contained in:
38
docs/Scalable Twelve Factor App.md
Normal file
38
docs/Scalable Twelve Factor App.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# Scalable Twelve-Factor App
|
||||
https://12factor.net/
|
||||
|
||||
The twelve-factor app is a methodology for building software-as-a-service apps that:
|
||||
|
||||
Use declarative formats for setup automation, to minimize time and cost for new developers joining the project;
|
||||
Have a clean contract with the underlying operating system, offering maximum portability between execution environments;
|
||||
Are suitable for deployment on modern cloud platforms, obviating the need for servers and systems administration;
|
||||
Minimize divergence between development and production, enabling continuous deployment for maximum agility;
|
||||
And can scale up without significant changes to tooling, architecture, or development practices.
|
||||
|
||||
I. Codebase
|
||||
One codebase tracked in revision control, many deploys
|
||||
II. Dependencies
|
||||
Explicitly declare and isolate dependencies
|
||||
III. Config
|
||||
Store config in the environment
|
||||
IV. Backing services
|
||||
Treat backing services as attached resources
|
||||
V. Build, release, run
|
||||
Strictly separate build and run stages
|
||||
VI. Processes
|
||||
Execute the app as one or more stateless processes
|
||||
VII. Port binding
|
||||
Export services via port binding
|
||||
VIII. Concurrency
|
||||
Scale out via the process model
|
||||
IX. Disposability
|
||||
Maximize robustness with fast startup and graceful shutdown
|
||||
X. Dev/prod parity
|
||||
Keep development, staging, and production as similar as possible
|
||||
XI. Logs
|
||||
Treat logs as event streams
|
||||
XII. Admin processes
|
||||
Run admin/management tasks as one-off processes
|
||||
|
||||
# Django Logging
|
||||
https://lincolnloop.com/blog/django-logging-right-way/
|
||||
Reference in New Issue
Block a user