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

Missing documentation/example of "series" taxonomy #865

Open
JensRantil opened this issue Nov 26, 2023 · 5 comments
Open

Missing documentation/example of "series" taxonomy #865

JensRantil opened this issue Nov 26, 2023 · 5 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@JensRantil
Copy link
Contributor

https://github.com/luizdepra/hugo-coder/blob/main/archetypes/posts.md contains three types of taxonomies. One of them is "series". How do I use "series"? Could it be added to the demo site? Document in README?

Background is that I am writing my first blog post series right now. But given that I don't know how I should use series (IIRC, it gave me an error). I currently link to a category to list the series, but I assume I should somehow use series.

@luizdepra
Copy link
Owner

Hey!

There is an example of series on the demo. But, yeah, it is shady and undocumented.

https://hugo-coder.netlify.app/series/theme-demo/

@luizdepra luizdepra added help wanted Extra attention is needed good first issue Good for newcomers enhancement New feature or request labels Nov 29, 2023
@JensRantil
Copy link
Contributor Author

Whoa! Missed that. Just curious, what's the intended difference semantically between series, tags and categories?

@luizdepra
Copy link
Owner

luizdepra commented Nov 30, 2023

Ahh right. I forgot to explain that.

Tags are like keywords or small topics about a page. Ex: Python, Rust, Singleton Pattern, Facade Pattern, Bench Saw
Categories are broader topics or genres. Ex: Programming Languages, Design Patterns, Woodworking
Series are a way to group related posts. Let's say you wrote a sequence of 3 posts about how to build microservices with Go: "Building a microservice with Go", "Building a microservice with Go (part 2)" and "Better patterns for a microservice made with Go". So you could group them in a series like "Microservices made with Go".

@JensRantil
Copy link
Contributor Author

@luizdepra Thanks for clarifying! This might be very useful to document in the README.

One follow-up question: Is there an easy way to add a description to a series? For example, adding something like "This series is about the different way you can customise a theme." to https://hugo-coder.netlify.app/series/theme-demo/.

@luizdepra
Copy link
Owner

@luizdepra Thanks for clarifying! This might be very useful to document in the README.

Sure. I need to rewrite some of the docs. It is getting really messy.

One follow-up question: Is there an easy way to add a description to a series? For example, adding something like "This series is about the different way you can customise a theme." to https://hugo-coder.netlify.app/series/theme-demo/.

Sadly, I don't see an easy way to do it. I think it is not possible to add an extra value to a series, tag or category with a simple configuration. But, It might be possible to override the index template for a series and add a description section. But you'll need to create a folder and a _index.md file for every series.

I think this text explains better: https://github.com/guayom/hugo-taxonomies

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants