Skip to content

Make Ralph functionalities more obvious to new users #428

@Leobouloc

Description

@Leobouloc

When I first discovered Ralph, it took me some digging into the code and discussions with team members to fully understand the multiple facets of Ralph. In particular, the data processing/validating tool AND the LRS server. I believe we would benefit from improving the doc and code structure to make clearer these different aspects.

Below is a first suggestion. Perhaps we could discuss here of other ways to make Ralph more accessible to first time users ?

Separate data processing and LRS management in cli ?

Currently, the ralph command is used both to:

  • read / write / transform statements
  • manage the Ralph LRS by creating users (by writing to auth.json)

This seems like very different tasks. I am wondering if it would make things clearer for new users to separate these functions by having two commands. For example ralph and ralph-LRS-admin ?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    Status

    Closed

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions