Skip to content
Snippets Groups Projects

Proposed change to Git LFS page

Merged Mike Jang requested to merge mjang-test-group/gitlab:mjang-proposed-lfs-doc-change into master
All threads resolved!

What does this MR do?

I'm proposing some changes to https://docs.gitlab.com/ee/topics/git/lfs/, primarily for clarity. However, I have:

  • Rewritten the intro as a Concept topic type
  • Moved the image after the instructions to install LFS on the server and client
  • Checked my proposed change through Vale. I improved readability from 8.11 to 7.83.

In addition:

  • I'm tempted to add a link to OAuth 2 docs (see Line 60), as I'm pretty sure that'll also work as as an HTTPS credential store.
  • I would have changed more titles to avoid "ing" verbs (such as "Using Git LFS" -> "Use Git LFS", but I didn't want to break links, and prefer an MVC.
  • Before I set up this MR, I used this procedure to build the doc locally: https://gitlab.com/gitlab-org/gitlab-docs/-/blob/main/doc/setup.md

Related issues

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.

cc @kpaizee

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • Mike Jang resolved all threads

    resolved all threads

  • Mike Jang added 1 commit

    added 1 commit

    Compare with previous version

  • Mike Jang marked this merge request as ready

    marked this merge request as ready

  • requested review from @msedlakjakubowski

  • Mike Jang added 61 commits

    added 61 commits

    Compare with previous version

  • changed milestone to %16.11

  • Marcin Sedlak-Jakubowski
  • Marcin Sedlak-Jakubowski approved this merge request

    approved this merge request

  • Marcin Sedlak-Jakubowski requested review from @j.seto and removed review request for @msedlakjakubowski

    requested review from @j.seto and removed review request for @msedlakjakubowski

  • Hi @msedlakjakubowski :wave:,

    GitLab Bot has added the Technical Writing label because a Technical Writer has approved or merged this MR.

    This message was generated automatically. You're welcome to improve it.

  • Jerry Seto
  • Mike Jang added 1 commit

    added 1 commit

    Compare with previous version

  • Mike Jang reset approvals from @msedlakjakubowski by pushing to the branch

    reset approvals from @msedlakjakubowski by pushing to the branch

  • Mike Jang added 1 commit

    added 1 commit

    • 743ce4fd - Apply 1 suggestion(s) to 1 file(s)

    Compare with previous version

  • Mike Jang added 1 commit

    added 1 commit

    • 73c699d6 - Apply 1 suggestion(s) to 1 file(s)

    Compare with previous version

  • Mike Jang resolved all threads

    resolved all threads

  • Mike Jang
  • Mike Jang resolved all threads

    resolved all threads

  • Mike Jang added 1 commit

    added 1 commit

    Compare with previous version

  • Mike Jang resolved all threads

    resolved all threads

  • Jerry Seto enabled an automatic merge when the pipeline for 6f9453fb succeeds

    enabled an automatic merge when the pipeline for 6f9453fb succeeds

  • 1 Warning
    :warning: d0299272: The commit subject must contain at least 3 words. For more information, take a look at our Commit message guidelines.
    1 Message
    :book: This merge request adds or changes documentation files. A review from the Technical Writing team before you merge is recommended. Reviews can happen after you merge.

    Documentation review

    The following files require a review from a technical writer:

    The review does not need to block merging this merge request. See the:

    If needed, you can retry the :repeat: danger-review job that generated this comment.

    Generated by :no_entry_sign: Danger

  • merged

  • @mikejang, how was your code review experience with this merge request? Please tell us how we can continue to iterate and improve:

    1. React with a :thumbsup: or a :thumbsdown: on this comment to describe your experience.
    2. Create a new comment starting with @gitlab-bot feedback below, and leave any additional feedback you have for us in the comment.

    Subscribe to the GitLab Community Newsletter for contributor-focused content and opportunities to level up.

    Thanks for your help! :heart:

    This message was generated automatically. You're welcome to improve it.

  • @mikejang, congratulations for getting your first MR merged :tada:

    If this is your first MR against a GitLab project, we'd like to invite and encourage you to self-nominate yourself for First MR Merged swag prize here.

    Thank you again for contributing, what's your next contribution going to be? :thinking:

    This message was generated automatically. You're welcome to improve it.

  • Jerry Seto mentioned in commit a3b1b45f

    mentioned in commit a3b1b45f

  • Please register or sign in to reply
    Loading