Skip to content

Commit

Permalink
Add a FAQ part in README
Browse files Browse the repository at this point in the history
and mention the git lfs feedback (closes #104)
  • Loading branch information
cderv committed Apr 23, 2024
1 parent 5a5a0c0 commit 13a0dde
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,18 @@
- [R Manuals Quarto website](https://rstudio.github.io/r-manuals/) ([source](https://github.com/rstudio/r-manuals), [workflow file](https://github.com/rstudio/r-manuals/blob/main/.github/workflows/build-website.yaml)) This projects uses a workflow to build several books with R and Quarto and organizes them in a website deployed to Github pages.

- [Pathology Atlas](https://www.patolojiatlasi.com/EN) ([source](https://github.com/patolojiatlasi/patolojiatlasi.github.io), [workflow file](https://github.com/patolojiatlasi/patolojiatlasi.github.io/blob/main/.github/workflows/Quarto-Render-Bilingual-Book-Push-Other-Repos-GitLab.yml)) This multilingual website is rendered in two versions and deployed using Github Actions.

## FAQ

* My project uses git lfs storage; how should I adapt the action?

If your project uses git lfs storage, you must opt-in to git lfs during `checkout` step.

```yaml
- name: Check out repository
uses: actions/checkout@v4
with:
lfs: true # needed when using lfs for image storage
```
See the [checkout action documentation](https://github.com/actions/checkout) for details.

0 comments on commit 13a0dde

Please sign in to comment.