RSE-Sheffield / git-github-zero-to-hero

Training materials for zero to hero training in version control through git, github and gitkraken
https://srse-git-github-zero2hero.netlify.app/
17 stars 10 forks source link

31 | Adding a new section for FAQ, Glossary and Links #32

Closed ns-rse closed 2 years ago

ns-rse commented 2 years ago

First draft on an FAQ, Glossary and links.

Took guidance for the glossary from the official Git - gitglossary.

Feedback welcome on mistakes/formatting (I'm sure there are a few.

annakrystalli commented 2 years ago

Just spying here but these are some excellent additions! 🤩

ns-rse commented 2 years ago

Thanks @annakrystalli the course itself is amazing, sort of thing I wish I'd had when starting out.

davidwilby commented 2 years ago

@ns-rse This is excellent, thanks for doing this. It's great to have the structure and the content you've written so far is great.

Perhaps we should just have a bit more of a think about the answer to whether commits can be deleted, but otherwise this looks brilliant.

ns-rse commented 2 years ago

Addressed all feedback, thank you.

One thing I can't work out having looked at the preview is how to include a link to these in the side-bar. I suspect its something in config.toml but I can only see the configuration options for the links that appear under More (for Github repo / Snippets / Credits / CC-BY Licence) and not how the Chapters or Setup section are included.

If anyone knows how to do this I'd be very grateful (without a sidebar link the additions are fairly pointless!).

ns-rse commented 2 years ago

Ah, I may have just worked this out as I hadn't included _index.en.md

annakrystalli commented 2 years ago

For me it's turning up locally but the weights and pre haven't been set correctly:

image
annakrystalli commented 2 years ago

I've made a quick commit that fixes it for me locally

annakrystalli commented 2 years ago

To be honest it doesn't seem the previews are working properly. Try testing out locally

ns-rse commented 2 years ago

No joy locally :cry:

hugo -d public

builds the site but without a menu item to "FAQ, Glossary and Links".

I'm tempted to merge the content and create myself a separate issue to investigate why its not rendering. Any objections to this?

As an aside reordering of the configuration options in netlify.toml appears to have got rid of the errors that were occurring.

I just moved the [context.deploy-preview] to be before [context.deploy-preview.environment] as the original order was causing...

2:50:22 PM: Incorrect TOML configuration format: Key deploy-preview is already used as table key
2:50:22 PM: Incorrect TOML configuration format: Key deploy-preview is already used as table key
2:50:22 PM: Post processing - header rules
2:50:23 PM: Incorrect TOML configuration format: Key deploy-preview is already used as table key
2:50:23 PM: Post processing - redirect rules
2:50:23 PM: Incorrect TOML configuration format: Key deploy-preview is already used as table key
2:50:23 PM: Post processing done
annakrystalli commented 2 years ago

One quick check. Are you sure you were in the correct branch?

annakrystalli commented 2 years ago

And also that you pulled my commit?

ns-rse commented 2 years ago

Hi @annakrystalli

Yep was on ns-rse/31-faq and had git pull'd (you're changes are still there in the diff) and locally I have...


 ❱ cat content/faq-glossary-links/_index.en.md
---
chapter: true
date: "2022-07-06T18:37:16+01:00"
pre: <b><i class="fa fa-question-circle" aria-hidden="true"></i> </b>
title: FAQ, Glossary and Links
weight: 6
---

# FAQ, Glossary and Links