Skip to content

docs/update-technical-discrepancies #4074

@Muawiya-contact

Description

@Muawiya-contact

crowd.dev edition

Community (self hosted)

Version

  • crowd.dev Edition: Community Edition (applies to all) -

Link

Link: README.md

Describe the problem

The README.md and other documentation contain outdated technical information that blocks new developers from successfully setting up the development environment:

  1. Outdated Node Version

    • Current documentation specifies: Node v16.16.0 (from 2021)
    • Actual requirement: Node v20+ (per GitHub Actions CI/CD workflows)
    • Impact: New developers encounter dependency compatibility errors
  2. Incorrect GitHub Organization URLs

    • Documentation still references old organization: CrowdDotDev/crowd.dev
    • Should reference: linuxfoundation/crowd.dev (post-acquisition April 2024)
    • Impact: Clone URLs fail, contributing links redirect to archived org
  3. Missing Environment Variable Documentation

    • WITH_INSIGHTS=1 not documented (enables Tinybird, Sequin, Kafka)
    • Network configuration variables undocumented
    • Impact: Developers cannot customize local setup or troubleshoot issues

Describe the improvement

Update the following files to reflect current technical requirements:

User-Facing Documentation (High Priority):

  • README.md - Update Node version and clone URL
  • CONTRIBUTING.md - Update all GitHub organization references

Build & Deployment Scripts (Medium Priority):

  • scripts/cli - Update deployment repository variables
  • scripts/services/docker/Dockerfile.script_executor - Update git clone
  • scripts/scaffold/kafka-connect/build-docker-image.sh - Update artifact URLs

Supporting Files (Lower Priority):

  • frontend/docs/custom-logos.md - Update contributing link
  • backend/.../webhooks/__tests__/events.ts - Update test fixtures

Additional context

📝 Current State

The README warning explicitly states: ⚠️ "This documentation is outdated and needs to be reviewed"


📊 Files Affected

  • 8 files with outdated URLs
  • 100+ total occurrences of CrowdDotDev/crowd.dev to update

🔄 Implementation Status

A branch has been prepared with all corrections: docs/update-technical-discrepancies

Changes Summary:

  • Node v16.16.0 → v20+
  • CrowdDotDev → linuxfoundation (all repos)
  • All build scripts and documentation links updated
  • Test fixtures updated for consistency

📋 Notes for Contributors

I follow-up repository strictly contributing guidelines. All contributions must:

  1. ✅ Comply with community standards and quality guidelines
  2. ✅ Include appropriate commit messages
  3. ✅ Update relevant documentation
  4. ✅ Pass CI/CD checks
  5. ✅ Be reviewed by maintainers

🔗 Related Links

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions