nmfs-opensci / GitHub-Guide

GitHub Guide developed by NMFS Open Science
https://nmfs-opensci.github.io/GitHub-Guide
Other
4 stars 3 forks source link

Rm extra files #11

Closed k-doering-NOAA closed 12 months ago

k-doering-NOAA commented 1 year ago
k-doering-NOAA commented 1 year ago

@eeholmes, my attempt at trying to reduce confusion :)

eeholmes commented 1 year ago

Alas if we remove index.qmd then when you try to render on your computer, it won't work because _quarto.yml needs index.qmd. It needs it so that this URL works https://nmfs-opensci.github.io/GitHub-Guide/ . What we could do is remove GitHub-Guide.qmd and have the GitHub Action rename index.pdf to GitHub-Guide.qmd. Or just leave as is and try to remember to edit only GitHub-Guide.qmd.

The old action can definitely be removed.

k-doering-NOAA commented 1 year ago

This option sounds good to me:

What we could do is remove GitHub-Guide.qmd and have the GitHub Action rename index.pdf to GitHub-Guide.qmd

eeholmes commented 1 year ago

If we deleted GitHub-Guide.qmd on the main branch, we could also delete GitHub-Guide.pdf and have that only on the gh-pages branch but I worried that might be confusing to people who land on the repo. What do you think?

k-doering-NOAA commented 1 year ago

I just noticed the website already builds a pdf (I think?) and has a link to it: https://nmfs-opensci.github.io/GitHub-Guide/ (built pdf): https://nmfs-opensci.github.io/GitHub-Guide/index.pdf

Maybe, then, we don't need to also commit a pdf to main? That would also simplify the github action.