Skip to content

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
    • Help
    • Submit feedback
    • Contribute to GitLab
  • Sign in
haskell-gargantext
haskell-gargantext
  • Project
    • Project
    • Details
    • Activity
    • Releases
    • Cycle Analytics
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
    • Charts
  • Issues 175
    • Issues 175
    • List
    • Board
    • Labels
    • Milestones
  • Merge Requests 9
    • Merge Requests 9
  • CI / CD
    • CI / CD
    • Pipelines
    • Jobs
    • Schedules
    • Charts
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Members
    • Members
  • Collapse sidebar
  • Activity
  • Graph
  • Charts
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
  • gargantext
  • haskell-gargantexthaskell-gargantext
  • Issues
  • #420

Closed
Open
Opened Oct 23, 2024 by Grégoire Locqueville@glocqueville
  • Report abuse
  • New issue
Report abuse New issue

Improve the project's file hierarchy and scripts

The project's file hierarchy could be improved and documented. Right now, the bin/ subdirectory contains both shell scripts and Haskell source files, and it is not clear to me what many of them do; there is a solitary Haskell source file in bench/.

If there is no objection, I will implement the following changes:

  • Split the contents of bin/ into two new top-level directories:
    • app/ (for Haskell source files --- app/ is a standard directory name for Haskell source code of executables)
    • scripts/ (for the rest)
  • Move bench/ into app/
  • @cgenie also suggested that we move devops/ into scripts/, but upon reflection I am not sure what the rationale for this is --- or maybe the scripts and devops/ should live in the same subdirectory, but scripts/ is not the right name? Maybe you could elaborate on this?

On the longer term, it would also be beneficial to go over the scripts, document them, remove obsolete ones if any, add missing ones... We (the CNRS team) started trying to list the use cases for scripts, but it's an ongoing discussion; feel free to contribute with any insight or opinion. In any case, I am probably going to ask questions about the aim of existing scripts as I go over them.

Assignee
Assign to
None
Milestone
None
Assign milestone
Time tracking
None
Due date
None
0
Labels
None
Assign labels
  • View project labels
Reference: gargantext/haskell-gargantext#420