Add backend performance best practices

scripts/best-practice-dirs.cjs

@@ -5,7 +5,7 @@ const CONTENT_DIR = path.join(__dirname, '../content');
 // Directory containing the best-practices
 const BEST_PRACTICE_CONTENT_DIR = path.join(
   __dirname,
-  '../src/data/best-practices'
+  '../src/data/best-practices',
 );
 const bestPracticeId = process.argv[2];
 
@@ -33,18 +33,18 @@ if (!bestPracticeDirName) {
 
 const bestPracticeDirPath = path.join(
   BEST_PRACTICE_CONTENT_DIR,
-  bestPracticeDirName
+  bestPracticeDirName,
 );
 const bestPracticeContentDirPath = path.join(
   BEST_PRACTICE_CONTENT_DIR,
   bestPracticeDirName,
-  'content'
+  'content',
 );
 
 // If best practice content already exists do not proceed as it would override the files
 if (fs.existsSync(bestPracticeContentDirPath)) {
   console.error(
-    `Best Practice content already exists @ ${bestPracticeContentDirPath}`
+    `Best Practice content already exists @ ${bestPracticeContentDirPath}`,
   );
   process.exit(1);
 }
@@ -88,10 +88,12 @@ function prepareDirTree(control, dirTree) {
   return { dirTree };
 }
 
-const bestPractice = require(path.join(
-  __dirname,
-  `../public/jsons/best-practices/${bestPracticeId}`
-));
+const bestPractice = require(
+  path.join(
+    __dirname,
+    `../src/data/best-practices/${bestPracticeId}/${bestPracticeId}`,
+  ),
+);
 const controls = bestPractice.mockup.controls.control;
 
 // Prepare the dir tree that we will be creating

src/data/best-practices/backend-performance/backend-performance.md

@@ -0,0 +1,30 @@
+---
+jsonUrl: '/jsons/best-practices/backend-performance.json'
+pdfUrl: '/pdfs/best-practices/backend-performance.pdf'
+order: 1
+briefTitle: 'Backend Performance'
+briefDescription: 'Backend Performance Best Practices'
+isNew: true
+isUpcoming: false
+title: 'Backend Performance Best Practices'
+description: 'Detailed list of best practices to improve your backend performance'
+dimensions:
+  width: 968
+  height: 1860.38
+schema:
+  headline: 'Backend Performance Best Practices'
+  description: 'Detailed list of best practices to improve the backend performance of your website. Each best practice carries further details and how to implement that best practice.'
+  imageUrl: 'https://roadmap.sh/best-practices/backend-performance.png'
+  datePublished: '2023-01-23'
+  dateModified: '2023-01-23'
+seo:
+  title: 'Backend Performance Best Practices'
+  description: 'Detailed list of best practices to improve the backend performance of your website. Each best practice carries further details and how to implement that best practice.'
+  keywords:
+    - 'backend performance'
+    - 'api performance'
+    - 'backend performance best practices'
+    - 'backend performance checklist'
+    - 'backend checklist'
+    - 'make performant backends'
+---

src/data/best-practices/backend-performance/content/architectural-styles.md

@@ -0,0 +1 @@
+# Architectural styles

src/data/best-practices/backend-performance/content/async-logging.md

@@ -0,0 +1 @@
+# Async logging

src/data/best-practices/backend-performance/content/authentication-authorization.md

@@ -0,0 +1 @@
+# Authentication authorization

src/data/best-practices/backend-performance/content/cache-invalidation.md

@@ -0,0 +1 @@
+# Cache invalidation

src/data/best-practices/backend-performance/content/caching-locations.md

@@ -0,0 +1 @@
+# Caching locations

src/data/best-practices/backend-performance/content/caching-strategies.md

@@ -0,0 +1 @@
+# Caching strategies

src/data/best-practices/backend-performance/content/cdns.md

@@ -0,0 +1 @@
+# Cdns

src/data/best-practices/backend-performance/content/cleanup-data.md

@@ -0,0 +1 @@
+# Cleanup data

src/data/best-practices/backend-performance/content/compiled-languages.md

@@ -0,0 +1 @@
+# Compiled languages

src/data/best-practices/backend-performance/content/connection-pool-settings.md

@@ -0,0 +1 @@
+# Connection pool settings

src/data/best-practices/backend-performance/content/connection-pooling.md

@@ -0,0 +1 @@
+# Connection pooling

src/data/best-practices/backend-performance/content/connection-timeouts.md

@@ -0,0 +1 @@
+# Connection timeouts

src/data/best-practices/backend-performance/content/critical-paths.md

@@ -0,0 +1 @@
+# Critical paths

src/data/best-practices/backend-performance/content/db-indexes.md

@@ -0,0 +1 @@
+# Db indexes

src/data/best-practices/backend-performance/content/denormalize.md

@@ -0,0 +1 @@
+# Denormalize

src/data/best-practices/backend-performance/content/enable-compression.md

@@ -0,0 +1 @@
+# Enable compression

src/data/best-practices/backend-performance/content/implement-pagination.md

@@ -0,0 +1 @@
+# Implement pagination

src/data/best-practices/backend-performance/content/index.md

@@ -0,0 +1 @@
+# 

src/data/best-practices/backend-performance/content/join-operations.md

@@ -0,0 +1 @@
+# Join operations

src/data/best-practices/backend-performance/content/keep-alive.md

@@ -0,0 +1 @@
+# Keep alive

src/data/best-practices/backend-performance/content/lazy-eager.md

@@ -0,0 +1 @@
+# Lazy eager

src/data/best-practices/backend-performance/content/load-balancing.md

@@ -0,0 +1 @@
+# Load balancing

src/data/best-practices/backend-performance/content/message-brokers.md

@@ -0,0 +1 @@
+# Message brokers

src/data/best-practices/backend-performance/content/minimize-iframe-count.md

@@ -0,0 +1 @@
+# Minimize iframe count

src/data/best-practices/backend-performance/content/monitoring-logging.md

@@ -0,0 +1 @@
+# Monitoring logging

src/data/best-practices/backend-performance/content/network-latency.md

@@ -0,0 +1 @@
+# Network latency

src/data/best-practices/backend-performance/content/offload-heavy.md

@@ -0,0 +1 @@
+# Offload heavy

src/data/best-practices/backend-performance/content/optimize-algorithms.md

@@ -0,0 +1 @@
+# Optimize algorithms

src/data/best-practices/backend-performance/content/orm-queries.md

@@ -0,0 +1 @@
+# Orm queries

src/data/best-practices/backend-performance/content/pagination-large-data.md

@@ -0,0 +1 @@
+# Pagination large data

src/data/best-practices/backend-performance/content/perf-testing.md

@@ -0,0 +1 @@
+# Perf testing

src/data/best-practices/backend-performance/content/prefetch-preload.md

@@ -0,0 +1 @@
+# Prefetch preload

src/data/best-practices/backend-performance/content/profile-code.md

@@ -0,0 +1 @@
+# Profile code

src/data/best-practices/backend-performance/content/profiling-tools.md

@@ -0,0 +1 @@
+# Profiling tools

src/data/best-practices/backend-performance/content/prometheus-graphana.md

@@ -0,0 +1 @@
+# Prometheus graphana

src/data/best-practices/backend-performance/content/reasonable-payload.md

@@ -0,0 +1 @@
+# Reasonable payload

src/data/best-practices/backend-performance/content/regular-audits.md

@@ -0,0 +1 @@
+# Regular audits

src/data/best-practices/backend-performance/content/replication.md

@@ -0,0 +1 @@
+# Replication

src/data/best-practices/backend-performance/content/request-throttling.md

@@ -0,0 +1 @@
+# Request throttling

src/data/best-practices/backend-performance/content/scaling-strategies.md

@@ -0,0 +1 @@
+# Scaling strategies

src/data/best-practices/backend-performance/content/select-star.md

@@ -0,0 +1 @@
+# Select star

src/data/best-practices/backend-performance/content/similar-requests.md

@@ -0,0 +1 @@
+# Similar requests

src/data/best-practices/backend-performance/content/slow-logging.md

@@ -0,0 +1 @@
+# Slow logging

src/data/best-practices/backend-performance/content/streaming-large.md

@@ -0,0 +1 @@
+# Streaming large

src/data/best-practices/backend-performance/content/unnecessary-computation.md

@@ -0,0 +1 @@
+# Unnecessary computation

src/data/best-practices/backend-performance/content/up-to-date.md

@@ -0,0 +1 @@
+# Up to date

src/data/best-practices/backend-performance/content/use-db-sharding.md

@@ -0,0 +1 @@
+# Use db sharding

src/data/best-practices/backend-performance/content/utilize-caching.md

@@ -0,0 +1 @@
+# Utilize caching