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 159
    • Issues 159
    • List
    • Board
    • Labels
    • Milestones
  • Merge Requests 8
    • Merge Requests 8
  • 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
  • !309

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

Some more README restructuration

This time I think I am clear on what the building & running process is and what the purpose of each command is, and I tried to document it clearly again.

This may be deemed too verbose:

  • Maybe I went into too many basic details, I'll be happy to discuss what the right level of detail is;
  • But I also think there are too many ways to do the same thing documented in the README. It might be worth settling on one recommended way, and documenting the rest in an appendix or something like that.

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 0
  • Commits 1
  • Pipelines 1
  • Changes 1
Assignee
Assign to
None
Milestone
None
Assign milestone
Time tracking
1
Labels
Documentation
Assign labels
  • View project labels
Reference: gargantext/haskell-gargantext!309

Revert this merge request

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 merge request

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