quarto-dev / quarto-dev/quarto-cli

Document minimum git version for Quarto publish in our Step by Step guide

Open
#9,045 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
JavaScript
Stars
6k
Forks
458
Avg merge
1d 9h
Merged PRs (30d)
41

Description

What would you like to do?

Give feedback or suggest an improvement

Description

Feedback from https://github.com/quarto-dev/quarto-cli/issues/9025#issuecomment-1989502391 - Our Quarto manuscript walkthrough seems to have some technical requirements that are not that obvious for all R users

(1) turns out, latest version of Git is required.

Scotts-MacBook-Pro-2:MS-Open-Salmon-KG Scott$ quarto publish gh-pages
ERROR: git version 2.17.0 or higher is required to publish to GitHub Pages

I expected latest Git via updating Xcode on Mac. Nope.

Scotts-MacBook-Pro-2:MS-Open-Salmon-KG Scott$ git --version
git version 2.13.1

Fine, follow instructions to download GIT... Nope. Result: included image.
Plan B involves HomeBrew which is not a CRAN package: disconcerting,
paranoious.

Following a1462c403b6aa99af48cf989bae5594cfc32d1d6, we should maybe add in a few places the minimum git requirement for Quarto publish.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Step by Step guide and inspect commit a1462c403b6aa99af48cf989bae5594cfc32d1d6 for the relevant publishing documentation. Identify the places where Quarto publish requirements are described and document that Git 2.17.0 or higher is required. Done means the minimum Git version is clearly stated for the affected publishing workflow.

Written by the indexing model from the issue text.

Assessment

Tech stack
git
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.