Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Suggested additions based on running through this tutorial #9

Open
kaijagahm opened this issue Oct 29, 2024 · 2 comments
Open

Suggested additions based on running through this tutorial #9

kaijagahm opened this issue Oct 29, 2024 · 2 comments

Comments

@kaijagahm
Copy link

Hi @samanthacsik--I love this tutorial and used it with great success to make my own website! I'm now running through it with a colleague and we're hitting a few stumbling blocks, and I'd like to fork the repo, make some suggestions, and make a PR. Would you be ok with that?

Here are some examples of the things I'd suggest:

  • add note at the project creation step that you shouldn't check the Git repo checkbox, since we're going to do that later
  • add a note about SSH and HTTPS authentication, with some additional resources for folks to set that up. My colleague had to go through some extra steps to set up a PAT.
  • Add an explicit description of the general build cycle: render, stage, commit, push
  • add note about editing quarto documents--my colleague ran into trouble because his Quarto was defaulting to visual mode, so then when he tried to add/modify a yaml header block by typing three dashes, it escaped the dashes, causing the yaml to not render properly. We fixed this by switching to source mode, but it took us a while to figure it out.

Let me know if you have comments/changes you'd want to see to any of these, or if you'd be okay with me proceeding with a PR!

And thanks again for this extremely helpful tutorial.

@samanthacsik
Copy link
Collaborator

Hi @kaijagahm! Thank you for the kind words, I'm really happy to hear that you've had success with this tutorial. And I very much appreciate your willingness to suggest some clarifications.

Everything you listed sounds like a super helpful addition. I would just ask that you add the note about setting up a PAT in the callout box beneath the Create the scaffolding of your website section:

Screenshot 2024-10-30 at 8 12 35 PM

There are already detailed instructions for how to do so in the linked MEDS Installation guide, though you're absolutely right that it would be clearer if setting up a PAT was also included as a bullet point in the box itself.

Let me know what you think!

@kaijagahm
Copy link
Author

Sounds good; I'd be happy to do that. I'll get to work on these additions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants