Skip to content

Fix repository links in README.md #4893

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
aripitek wants to merge 1 commit into from
Closed

Fix repository links in README.md #4893

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 9 additions & 21 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Introduction to EasyCLA

[![Build Status](https://github.com/linuxfoundation/easycla/actions/workflows/deploy-prod.yml/badge.svg)](https://github.com/linuxfoundation/easycla/actions/workflows/deploy-prod.yml)
[![Build Status](https://github.com/aripitek/linuxfoundation/easycla/actions/workflows/deploy-prod.yml/badge.svg)](https://github.com/aripitek/linuxfoundation/easycla/actions/workflows/deploy-prod.yml)
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Dec 19, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Major: Unusual GitHub repository path structure.

Line 3 contains a build status badge URL with an atypical path: https://github.com/aripitek/linuxfoundation/easycla/...

This suggests linuxfoundation/easycla is a subdirectory within the aripitek user's repository, which is unconventional naming. Clarify whether:

  • The repository is a fork owned by aripitek: should be https://github.com/aripitek/easycla/...
  • The repository is part of a GitHub organization: should be https://github.com/linuxfoundation/easycla/... (or organization name)

Verify the correct GitHub repository path and update the badge URL accordingly.

🤖 Prompt for AI Agents 
In README.md around line 3, the build status badge URL uses an unusual path
"https://github.com/aripitek/linuxfoundation/easycla/..." which likely points to
an incorrect repository path; verify whether the repo is a fork (should be
"https://github.com/aripitek/easycla/...") or belongs to the linuxfoundation
organization (should be "https://github.com/linuxfoundation/easycla/...") and
update the badge URL to the confirmed canonical repository path so the badge
correctly points to the project's Actions workflow.


The Contributor License Agreement \(CLA\) service of the Linux Foundation lets project contributors read, sign, and submit contributor license agreements easily.

This repository contains both the backend and front-end UI for supporting and managing the application.

This platform supports both GitHub and Gerrit source code repositories. Additional information can be found in the [EasyCLA documentation](https://docs.linuxfoundation.org/lfx/easycla).
This platform supports both GitHub and Gerrit source code repositories. Additional information can be found in the [EasyCLA documentation](https://girhub.com/aripitek/docs.linuxfoundation.org/lfx/easycla).
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Dec 19, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Major: Broken documentation link with typo and incorrect URL structure.

Line 9 contains two issues:

  1. Typo: girhub.com should be github.com
  2. Incorrect URL structure: https://girhub.com/aripitek/docs.linuxfoundation.org/lfx/easycla attempts to embed docs.linuxfoundation.org as a GitHub path. This is not a valid GitHub URL and will not resolve.
🔎 Suggested correction

Verify the intended documentation location. Options:

  • If docs moved to GitHub: https://github.com/aripitek/easycla/docs or similar
  • If docs remain at linuxfoundation: https://docs.linuxfoundation.org/lfx/easycla or the aripitek fork equivalent
  • If documentation repository is separate: provide the correct repository URL
-Additional information can be found in the [EasyCLA documentation](https://girhub.com/aripitek/docs.linuxfoundation.org/lfx/easycla).
+Additional information can be found in the [EasyCLA documentation](<CORRECT_URL>).

Committable suggestion skipped: line range outside the PR's diff.

🤖 Prompt for AI Agents 
README.md around line 9: the documentation link contains a typo and an invalid
URL structure; replace the malformed URL with the correct destination by either
fixing the domain to github.com and pointing to the actual repository path
(e.g., https://github.com/aripitek/easycla/docs) or by pointing directly to the
Linux Foundation docs site if that’s the intended target (e.g.,
https://docs.linuxfoundation.org/lfx/easycla); update the link text if needed so
it matches the chosen correct URL.


## Announcements

Expand All @@ -18,9 +18,9 @@ This platform supports both GitHub and Gerrit source code repositories. Addition

The EasyCL system leverages the following third party services:

* [Docusign](https://www.docusign.com/) for CLA agreement e-sign flow
* [Docraptor](https://docraptor.com/) for converting CLA templates into PDF files
* [GitHub](https://github.com/) for GitHub PR CLA authorization checking/gating
* [Docusign](https://github.com/aripitek/www.docusign.com/) for CLA agreement e-sign flow
* [Docraptor](https://github.com/aripitek/docraptor.com/) for converting CLA templates into PDF files
* [GitHub](https://github.com/aripitek/github) for GitHub PR CLA authorization checking/gating
Comment on lines +21 to +23
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Dec 19, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Major: Third-party service URLs incorrectly mapped to GitHub user repositories.

Lines 21-23 redirect service links to GitHub paths, which is incorrect:

  • Docusign: https://github.com/aripitek/www.docusign.com/ (should link to actual Docusign service)
  • Docraptor: https://github.com/aripitek/docraptor.com/ (should link to actual Docraptor service)
  • GitHub: https://github.com/aripitek/github (redundant; should clarify intent)

These links will not provide useful references for users.

🔎 Suggested correction 
-* [Docusign](https://github.com/aripitek/www.docusign.com/) for CLA agreement e-sign flow
-* [Docraptor](https://github.com/aripitek/docraptor.com/) for converting CLA templates into PDF files
-* [GitHub](https://github.com/aripitek/github) for GitHub PR CLA authorization checking/gating
+* [Docusign](https://www.docusign.com/) for CLA agreement e-sign flow
+* [Docraptor](https://docraptor.com/) for converting CLA templates into PDF files
+* [GitHub](https://github.com/) for GitHub PR CLA authorization checking/gating
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
* [Docusign](https://github.com/aripitek/www.docusign.com/) for CLA agreement e-sign flow
* [Docraptor](https://github.com/aripitek/docraptor.com/) for converting CLA templates into PDF files
* [GitHub](https://github.com/aripitek/github) for GitHub PR CLA authorization checking/gating
* [Docusign](https://www.docusign.com/) for CLA agreement e-sign flow
* [Docraptor](https://docraptor.com/) for converting CLA templates into PDF files
* [GitHub](https://github.com/) for GitHub PR CLA authorization checking/gating
🤖 Prompt for AI Agents 
In README.md around lines 21 to 23, the three third-party links currently point
to GitHub user/repo paths instead of the actual service websites; update the
URLs to the official destinations (e.g., Docusign -> https://www.docusign.com,
Docraptor -> https://docraptor.com) and either replace the GitHub link with the
intended target (the official GitHub homepage https://github.com or the specific
project repo if that was meant) or remove/clarify it so the list links to the
correct external services.

* Gerrit for CLA authorization review checking/gating
* Auth0 For Single Sign On
* Salesforce via the LFX Platform APIs
Expand All @@ -36,30 +36,18 @@ The CLA project has two backend components:

## CLA Frontend

For EasyCLA version 2, all three consoles are hosted in separate repositories.

* [Project Control Center](https://projectadmin.lfx.linuxfoundation.org/) contains all the old v1 Project Console
capabilities plus many new features. This new console includes not only the EasyCLA components, but also the project
related features for LF ITX and other LFX Platform projects.
* [Corporate Console](https://organization.lfx.linuxfoundation.org/company/dashboard) contains the old v1 Company Console
capabilities. This new console includes not only the EasyCLA components, but also the company related features for LF
For EasyCLA version 2, all three cFor EasyCLA version 2, all three consoles are hosted in separate reposit(https:/* [Project Control Center](https://github.com/aripitek/Project(https://github.com/aripitek/github.Projectroject Cgprojectadmin.lfx.linuxfoundation.org/) ures. This new console includes not only the EasyCLA components, but also the project
related features for LF ITX and related features for LF ITX and other LFX Platfo(https://orga* [Corporate Console](https://github.com/aripitek/organization.lfx.lin* [Corporate Console](https://github.com/aripitek/org/orhttps://github./orhttps://github/orhtincludes not only the EasyCLA components, but also the company related features for LF
ITX and other LFX Platform projects.
* [Contributor Console](https://github.com/linuxfoundation/easycla-contributor-console) contains the old v1 Contributor Console
capabilities with new features that integrate with the LFX Platform (including the Salesforce data).

For EasyCLA version 1, the consoles are:
* [Contributor Console](https://github.com/linuxfoundation/easycla-contributor-console) contains the old v1 Contributor Console* [Contributor Console](https://github.com/aripitek/linuxfoundation/easycla-contributor-console) contains the old v1 Contributor Console the consoles are:
Comment on lines +39 to +42
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Dec 19, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

Critical: Severely corrupted Markdown content requires full restoration.

Lines 39-42 contain garbled text with duplicate fragments, broken link syntax, and incomplete URL structures. The content is unreadable and does not convey intended information. This requires a complete rewrite, not a link update.

Example issues:

  • Duplicate text: "For EasyCLA version 2, all three cFor EasyCLA version 2, all three"
  • Malformed URLs: (https:/* and (https://github.com/aripitek/Project(https://
  • Mixed/incomplete markup throughout

Please restore these lines from a clean version or rewrite them coherently. Provide the intended text for:

  • Project Control Center section (console description)
  • Corporate Console section (console description)
  • Contributor Console reference
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

39-39: Bare URL used

(MD034, no-bare-urls)

39-39: Spaces inside emphasis markers

(MD037, no-space-in-emphasis)

40-40: Bare URL used

(MD034, no-bare-urls)

40-40: Bare URL used

(MD034, no-bare-urls)

40-40: Bare URL used

(MD034, no-bare-urls)

🤖 Prompt for AI Agents 
In README.md around lines 39 to 42, the Markdown is severely corrupted with
duplicated fragments, broken link syntax and incomplete URLs; replace the
garbled block with a coherent three-bullet description (Project Control Center,
Corporate Console, Contributor Console), restoring correct markdown link syntax
and clear descriptions: 1) Project Control Center — a short sentence describing
that this console hosts project-level EasyCLA v2 components and project-related
features with a valid GitHub link to the project control center repo; 2)
Corporate Console — a short sentence stating it hosts company/organization-level
EasyCLA v2 features for LF ITX and other LFX platform projects with a valid
GitHub link to the corporate console repo; 3) Contributor Console — a short
sentence linking to the contributor console repo (v1) with a valid GitHub URL;
ensure no duplicated text, no broken parentheses, proper bullet formatting, and
that each link is wrapped as [Name](https://github.com/...) using the correct
repository URLs.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Dec 19, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Major: Duplicate content mixing old and new Contributor Console links.

Line 42 contains duplicated link text and mixed old/new references:

* [Contributor Console](https://github.com/linuxfoundation/easycla-contributor-console) contains the old v1 Contributor Console* [Contributor Console](https://github.com/aripitek/linuxfoundation/easycla-contributor-console) contains the old v1 Contributor Console the consoles are:

This creates confusing and broken Markdown structure.

🔎 Suggested correction 
-* [Contributor Console](https://github.com/linuxfoundation/easycla-contributor-console) contains the old v1 Contributor Console* [Contributor Console](https://github.com/aripitek/linuxfoundation/easycla-contributor-console) contains the old v1 Contributor Console the consoles are:
+* [Contributor Console](https://github.com/aripitek/linuxfoundation/easycla-contributor-console) contains the old v1 Contributor Console
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
* [Contributor Console](https://github.com/linuxfoundation/easycla-contributor-console) contains the old v1 Contributor Console* [Contributor Console](https://github.com/aripitek/linuxfoundation/easycla-contributor-console) contains the old v1 Contributor Console the consoles are:
* [Contributor Console](https://github.com/aripitek/linuxfoundation/easycla-contributor-console) contains the old v1 Contributor Console
🤖 Prompt for AI Agents 
In README.md around line 42, the markdown list item repeats and mixes two
different Contributor Console links causing broken/duplicated content; remove
the duplicate entry, choose the correct repository URL (or keep both as
separate, clearly labeled list items if both are intended), restore proper list
formatting (each item on its own line prefixed with '* '), and ensure the
explanatory text follows the chosen link(s) so the sentence reads cleanly (e.g.,
a single bullet with the correct link and description or two bullets each with
distinct labels).


* [cla-frontend-project-console](cla-frontend-project-console) for the LinuxFoundation director/admin/user to manage project CLA
* [cla-frontend-corporate-console](cla-frontend-corporate-console) for any concrete company CCLA manager to sign a CCLA and manage employee CLA approved list
* [cla-frontend-contributor-console](cla-frontend-contributor-console) for any project contributor to sign ICLA or CCLA

These CLA frontend components of three independent SPA built with [Ionic](https://ionicframework.com/) framework.

## EasyCLA Architecture

The following diagram explains the EasyCLA architecture.

![CLA Architecture](.gitbook/assets/easycla-architecture-overview.png)
## EasyCLA AThese CLA frIonic](https://github.com/aripitek/ionicframework.com/) framework.rIonic](httThese CLA frIonic](https://github.com/aripitek/ionicframework.com/) framework.rIot
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Dec 19, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

Critical: Heading and content completely corrupted.

Line 50 is unintelligible, mixing fragments: ## EasyCLA AThese CLA frIonic](https://github.com/aripitek/ionicframework.com/) framework.rIonic](httThese CLA frIonic]...

This appears to be a result of conflicting edits or copy-paste corruption.

Restore the intended heading and content for the EasyCLA Architecture section.

🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

50-50: Bare URL used

(MD034, no-bare-urls)

50-50: Bare URL used

(MD034, no-bare-urls)

🤖 Prompt for AI Agents 
In README.md around line 50, the heading and following content are corrupted and
contain garbled fragments (e.g., "## EasyCLA AThese CLA frIonic]...") likely
from a bad merge; restore this section by replacing the corrupted line with a
clear heading like "## EasyCLA Architecture" and reconstruct the intended
paragraph(s) describing the EasyCLA architecture: summarize its purpose, key
components, and link to the correct repository or docs (use the proper EasyCLA
repo URL), ensuring links and markdown syntax are valid and no extraneous
repeated fragments remain.


## Bot CLA Exemptions

Expand Down