Skip to content

docs: update outdated technical specs, Node version, and repository URLs#4075

Open
Muawiya-contact wants to merge 4 commits intolinuxfoundation:mainfrom
Muawiya-contact:docs/update-technical-discrepancies
Open

docs: update outdated technical specs, Node version, and repository URLs#4075
Muawiya-contact wants to merge 4 commits intolinuxfoundation:mainfrom
Muawiya-contact:docs/update-technical-discrepancies

Conversation

@Muawiya-contact
Copy link
Copy Markdown

@Muawiya-contact Muawiya-contact commented May 5, 2026

📌 Overview

This PR performs a much-needed technical audit of the project's documentation and bootstrap scripts. As noted in the README.md, the documentation was outdated, leading to friction for new developers attempting to set up the LFX Community Data Platform.

I have updated the environment requirements to match the current CI/CD reality and replaced legacy organization links to ensure the project correctly reflects its home under the Linux Foundation.


🛠 Technical Changes

1. Node.js Environment Update

  • Old Specs: Node v16.16.0 (Legacy)
  • New Specs: Node v20+ (LTS)
  • Why: Current dependencies and GitHub Action workflows are optimized for Node 20. Sticking to v16 causes silent failures during pnpm install or build steps.

2. Repository Link Migration (Global Update)

  • Change: Replaced 100+ instances of CrowdDotDev/crowd.dev with linuxfoundation/crowd.dev.
  • Affected Areas:
    • README.md (Clone URLs & Documentation links)
    • CONTRIBUTING.md
    • scripts/cli (Deployment and mirror paths)
    • Frontend documentation files.

3. Developer Experience (DX) Enhancements

  • Visibility: Added documentation for the WITH_INSIGHTS=1 environment variable. This was previously "hidden" in the scripts, making it difficult for developers to enable the Tinybird/Kafka stack locally.
  • Script Fixes: Updated Dockerfile.script_executor and several shell scripts in /scripts to ensure they point to the correct upstream repositories.

🧪 Verification & Testing

  • Verified that git clone works with the updated URLs.
  • Confirmed the project bootstraps correctly using Node v20.x.
  • Checked all updated Markdown links to ensure they don't lead to 404s.

👋 Note to Maintainers

I am a student developer currently finalizing a custom x86_64 kernel project (Arion OS). While working with the LFX ecosystem, I noticed these discrepancies and wanted to ensure the onboarding process is seamless for the next wave of contributors.

I've followed the contribution guidelines and signed off on my commits. I would appreciate a review so I can showcase this contribution during my OS presentation next week! 🚀


Note

Low Risk
Low risk documentation-only changes; main impact is updated setup expectations (Node v20+) and redirected GitHub/CLA links for contributors.

Overview
Updates contributor and developer setup docs to reflect the project’s move under Linux Foundation: GitHub issue/label links, git clone URLs, and CLA links now point to linuxfoundation/crowd.dev.

Bumps documented Node.js requirement from v16.16.0 to v20+, and expands CONTRIBUTING.md with clearer contribution workflow guidance (conventional commits, PR title/process expectations, and references for JIRA/AI guidelines).

Reviewed by Cursor Bugbot for commit 42b72ef. Bugbot is set up for automated code reviews on this repo. Configure here.

Copilot AI review requested due to automatic review settings May 5, 2026 18:49
@Muawiya-contact
Copy link
Copy Markdown
Author

Closes #4074

Comment thread CONTRIBUTING.md Outdated
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR refreshes developer-facing documentation and a few bootstrap/deploy scripts to reflect the repository’s current home under linuxfoundation/* and the project’s current Node.js baseline.

Changes:

  • Updated README Node requirement to Node v20+ and migrated primary clone/contributing URLs to linuxfoundation/crowd.dev.
  • Updated various scripts/Docker scaffolding references from CrowdDotDev/* to linuxfoundation/*.
  • Updated Kafka Connect scaffold references for the Tinybird SMT plugin release URL.

Reviewed changes

Copilot reviewed 7 out of 8 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
scripts/services/docker/Dockerfile.script_executor Updates the git clone URL used during image build to the linuxfoundation repo.
scripts/scaffold/kafka-connect/Dockerfile Updates the documented Tinybird SMT release URL to the linuxfoundation org.
scripts/scaffold/kafka-connect/build-docker-image.sh Updates the Tinybird SMT download URL to the linuxfoundation org.
scripts/cli Updates the target GitHub repository for staging/production deploy workflow dispatch.
README.md Updates Node requirement to v20+ and migrates clone/contributing links to linuxfoundation.
frontend/docs/custom-logos.md Migrates CONTRIBUTING link to linuxfoundation repo.
CONTRIBUTING.md Migrates multiple GitHub/CLA/onboarding links to linuxfoundation (but leaves some outdated items).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread CONTRIBUTING.md Outdated
Comment thread scripts/cli
Comment thread README.md
Comment thread CONTRIBUTING.md
- Update Node.js version requirement from v16.16.0 to v20+
  (aligns with GitHub Actions workflows and Docker images)
- Update GitHub organization URLs from CrowdDotDev to linuxfoundation
  (reflects Linux Foundation acquisition in April 2024)
- Update all deployment scripts, build files, and documentation links
- Update test fixtures to use new organization namespace

Fixes documentation inconsistencies that blocked new developers
during setup and onboarding.

Signed-off-by: Muawiya-contact <contactmuawia@gmail.com>
Signed-off-by: Muawiya-contact <contactmuawia@gmail.com>
@Muawiya-contact Muawiya-contact force-pushed the docs/update-technical-discrepancies branch from 3762f95 to 8d9dadc Compare May 6, 2026 01:05
Signed-off-by: Muawiya-contact <contactmuawia@gmail.com>
Copilot AI review requested due to automatic review settings May 6, 2026 01:12
Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

Reviewed by Cursor Bugbot for commit 42b72ef. Configure here.

Comment thread CONTRIBUTING.md
@Muawiya-contact
Copy link
Copy Markdown
Author

@joanagmaia

Following up on #4075 — documentation-only, low-risk changes:

  • Node v16 → v20+ (matches CI/CD)
  • 100+ CrowdDotDevlinuxfoundation URLs
  • WITH_INSIGHTS=1 env var documented
  • Fixed go.crowd.dev/discord link (was an uncommitted TODO — now properly linked, though the redirect itself may need checking on LFX side)

All bot feedback addressed. Happy to fix anything else — would love a review before merge.🙏

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants