chore: consolidate documentation — delete status/fix/progress cruft
Before: 335 tracked .md files; top level had 14 README-like docs; docs/ contained ~234 files, most of them auto/LLM-generated status reports (ALL_*_COMPLETE*, *_FIX*, DEPLOYMENT_*_FINAL*, etc.). After: 132 tracked .md files. Repo now has exactly five top-level docs: README.md, QUICKSTART.md, RUNBOOK.md, CONTRIBUTING.md, CHANGELOG.md (moved up from docs/). Keeper philosophy in docs/: - API, CCIP (ops + security + receiver/router refs), Chainlist refs, compliance, deployment (guides not status), database connection, legal compliance, metamask integration, production checklist, tiered-architecture implementation/setup, reusable-components plan, token-mechanism doc, wrap-and-bridge operational reference, plus docs/specs/** and docs/api/ / docs/openapi/ trees. Deleted (git history preserves provenance): - All 'ALL_*_COMPLETE*' / '*_FIX*' / '*_FIXED*' / '*_FINAL*' / '*_STATUS*' / '*_PROGRESS*' / '*_SUMMARY*' files. - BLOCKSCOUT_*_FIX / _CRASH / _INITIALIZATION / _SCHEMA / _YAML / _SKIP / _NEXT_STEPS / _START_AND_BUILD / _DATABASE_CREDENTIALS (the last contained passwords). - CCIP_IMPLEMENTATION_* / CCIP_CURRENT_STATUS / CCIP_GAP_* (gap analyses are not a sustained reference). - NPMPLUS_CREDENTIALS_GUIDE.md (contained creds). - LETSENCRYPT_CONFIGURATION_GUIDE.md (contained creds; will be re-introduced as runbook content post-secrets-scrub). - docs/diagnostic-reports/, docs/feature-flags/ (run-time artifacts). README.md: dead links (START_HERE, README_DEPLOYMENT, COMPLETE_DEPLOYMENT, DEPLOYMENT_COMPLETE_FINAL) replaced with links to the five canonical top-level docs + docs/ index.
This commit is contained in:
@@ -1,95 +0,0 @@
|
||||
# Fix YAML Quote Issues in docker-compose.yml
|
||||
|
||||
## Problem
|
||||
Docker Compose is failing with "No closing quotation" error because the command string has nested quotes that aren't properly escaped.
|
||||
|
||||
## Solution: Use YAML List Format
|
||||
|
||||
Instead of:
|
||||
```yaml
|
||||
command: sh -c "bin/blockscout eval \"Explorer.Release.migrate()\" && bin/blockscout start"
|
||||
```
|
||||
|
||||
Use YAML list format:
|
||||
```yaml
|
||||
command:
|
||||
- sh
|
||||
- -c
|
||||
- "bin/blockscout eval \"Explorer.Release.migrate()\" && bin/blockscout start"
|
||||
```
|
||||
|
||||
## Commands to Fix
|
||||
|
||||
```bash
|
||||
cd /opt/blockscout
|
||||
|
||||
# Backup
|
||||
cp docker-compose.yml docker-compose.yml.backup3
|
||||
|
||||
# Fix using Python
|
||||
python3 << 'PYTHON'
|
||||
import re
|
||||
|
||||
with open('docker-compose.yml', 'r') as f:
|
||||
lines = f.readlines()
|
||||
|
||||
new_lines = []
|
||||
i = 0
|
||||
while i < len(lines):
|
||||
line = lines[i]
|
||||
# Check if this is a command line with blockscout start
|
||||
if 'command:' in line and ('blockscout start' in line or '/app/bin/blockscout start' in line):
|
||||
# Replace with YAML list format
|
||||
indent = len(line) - len(line.lstrip())
|
||||
new_lines.append(' ' * indent + 'command:\n')
|
||||
new_lines.append(' ' * (indent + 2) + '- sh\n')
|
||||
new_lines.append(' ' * (indent + 2) + '- -c\n')
|
||||
new_lines.append(' ' * (indent + 2) + '- "bin/blockscout eval \\"Explorer.Release.migrate()\\" && bin/blockscout start"\n')
|
||||
i += 1
|
||||
# Skip continuation lines if any
|
||||
while i < len(lines) and (lines[i].strip().startswith('-') or lines[i].strip() == ''):
|
||||
i += 1
|
||||
continue
|
||||
new_lines.append(line)
|
||||
i += 1
|
||||
|
||||
with open('docker-compose.yml', 'w') as f:
|
||||
f.writelines(new_lines)
|
||||
|
||||
print("✅ Updated docker-compose.yml")
|
||||
PYTHON
|
||||
|
||||
# Verify
|
||||
grep -A 4 "command:" docker-compose.yml
|
||||
|
||||
# Start
|
||||
docker-compose up -d blockscout
|
||||
```
|
||||
|
||||
## Alternative: Manual Edit
|
||||
|
||||
If Python doesn't work, edit manually:
|
||||
|
||||
```bash
|
||||
cd /opt/blockscout
|
||||
nano docker-compose.yml
|
||||
```
|
||||
|
||||
Find:
|
||||
```yaml
|
||||
command: /app/bin/blockscout start
|
||||
```
|
||||
|
||||
Replace with:
|
||||
```yaml
|
||||
command:
|
||||
- sh
|
||||
- -c
|
||||
- "bin/blockscout eval \"Explorer.Release.migrate()\" && bin/blockscout start"
|
||||
```
|
||||
|
||||
Save and exit, then:
|
||||
```bash
|
||||
docker-compose up -d blockscout
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user