Project

General

Profile

Actions

Bug #10762

closed

Agent build documentation in GitHub README is out of date

Added by Florian Heigl almost 7 years ago. Updated almost 7 years ago.

Status:
Released
Priority:
N/A
Category:
Documentation
Target version:
Severity:
Minor - inconvenience | misleading | easy workaround
UX impact:
User visibility:
First impressions of Rudder
Effort required:
Very Small
Priority:
83
Name check:
Fix check:
Regression:

Description

1)
The git instructions are telling you to go to SOURCES of your favorite build target, export your target branch via env, and then to hit "make"
This does run into multiple dependency issues.

Please try building from a "lean" debian install and adjust what the makefile does, or require an installation of build-essentials plus whatever is on top of that, only.

2)
I was pointed at a different document (in the manual, with quite different instructions, i.e. still hand-editing RUDDER_VERSION_TO_BUILD and manually doing a checkout.

Please spend some time to make all your build documentations refer each other correctly or have them be in sync.

I know it's improved already, but please keep going. It feels like it primarily affects the persons with potential to contribute to Rudder.

Actions

Also available in: Atom PDF