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 154
    • Issues 154
    • List
    • Board
    • Labels
    • Milestones
  • Merge Requests 7
    • Merge Requests 7
  • 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
  • Merge Requests
  • !304

Merged
Opened Jul 08, 2024 by Grégoire Locqueville@glocqueville
  • Report abuse
Report abuse

README improvements

Various clarifications and reformulations based on my experience using the README to build and run Gargantext. In particular:

  • Information related to development has been given its own section
  • Docker Compose has been added to the list of prerequisites
  • Information pertaining to using Stack has been moved to an annex file
  • The content to be copypasted into a cabal.project.local file has been moved out of the README into a separate file cabal.project.local_toCopy

Those may not be the best decisions, I am happy to discuss them if needed

Closes #365 (closed)

Check out, review, and merge locally

Step 1. Fetch and check out the branch for this merge request

git fetch origin
git checkout -b 365-documentation-improve-readme origin/365-documentation-improve-readme

Step 2. Review the changes locally

Step 3. Merge the branch and fix any conflicts that come up

git fetch origin
git checkout origin/dev
git merge --no-ff 365-documentation-improve-readme

Step 4. Push the result of the merge to GitLab

git push origin dev

Note that pushing to GitLab requires write access to this repository.

Tip: You can also checkout merge requests locally by following these guidelines.

  • Discussion 1
  • Commits 1
  • Pipelines 1
  • Changes 3
Assignee
Assign to
None
Milestone
None
Assign milestone
Time tracking
1
Labels
Documentation
Assign labels
  • View project labels
Reference: gargantext/haskell-gargantext!304

Revert this commit

This will create a new commit in order to revert the existing changes.

Switch branch
Cancel
A new branch will be created in your fork and a new merge request will be started.

Cherry-pick this commit

Switch branch
Cancel
A new branch will be created in your fork and a new merge request will be started.