docs: update outdated technical specs, Node version, and repository URLs#4075
docs: update outdated technical specs, Node version, and repository URLs#4075Muawiya-contact wants to merge 4 commits intolinuxfoundation:mainfrom
Conversation
|
Closes #4074 |
There was a problem hiding this comment.
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/*tolinuxfoundation/*. - 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.
- 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>
3762f95 to
8d9dadc
Compare
Signed-off-by: Muawiya-contact <contactmuawia@gmail.com>
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
Reviewed by Cursor Bugbot for commit 42b72ef. Configure here.
|
Following up on #4075 — documentation-only, low-risk changes:
All bot feedback addressed. Happy to fix anything else — would love a review before merge.🙏 |

📌 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
pnpm installor build steps.2. Repository Link Migration (Global Update)
CrowdDotDev/crowd.devwithlinuxfoundation/crowd.dev.README.md(Clone URLs & Documentation links)CONTRIBUTING.mdscripts/cli(Deployment and mirror paths)3. Developer Experience (DX) Enhancements
WITH_INSIGHTS=1environment variable. This was previously "hidden" in the scripts, making it difficult for developers to enable the Tinybird/Kafka stack locally.Dockerfile.script_executorand several shell scripts in/scriptsto ensure they point to the correct upstream repositories.🧪 Verification & Testing
git cloneworks with the updated URLs.👋 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 cloneURLs, and CLA links now point tolinuxfoundation/crowd.dev.Bumps documented Node.js requirement from
v16.16.0tov20+, and expandsCONTRIBUTING.mdwith 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.