search

LisaFC / docsysite

Draft version of Docsy site and user guide. WIP!
Apache License 2.0
0 stars 2 forks source link

new "best practices" section #13

Closed RichieEscarez closed 5 years ago

RichieEscarez commented 5 years ago

add

RichieEscarez commented 5 years ago

@rionam

LisaFC commented 5 years ago

Hmmmmmmm, I'm really not keen on mixing in "here's where you can learn about site organization" and "here's where you can learn about Hugo" - the former is "best practices" in the sense that it (hopefully) produces more usable content based on our user research and experience, the other is more tips and tricks for working with a new tool. They don't seem like the same category of thing.

How about: We keep this page as Organizing your Content BUT! we drop it down a level and create a Best Practices section. It can contain Organizing your Content and also Hugo Tips.

@rionam? thoughts?

RichieEscarez commented 5 years ago

Hmmmmmmm, I'm really not keen on mixing in "here's where you can learn about site organization" and "here's where you can learn about Hugo" - the former is "best practices" in the sense that it (hopefully) produces more usable content based on our user research and experience, the other is more tips and tricks for working with a new tool. They don't seem like the same category of thing.

How about: We keep this page as Organizing your Content BUT! we drop it down a level and create a Best Practices section. It can contain Organizing your Content and also Hugo Tips.

@rionam? thoughts?

People wont look in an "organizing" topic for tooling related best practices.

How about a "Best Practices" landing page with two children (writing best practices & tooling best practices)?

LisaFC commented 5 years ago

How about a "Best Practices" landing page with two children (writing best practices & tooling best practices)?

That's what I meant! (though I probably could have been clearer - I meant the Best Practices section would contain the two docs, not that Organizing your Content would contain them)

I'd just have the existing Organizing your Content page as one child, and then Hugo Tips or something as the other one. A lot of the Hugo info isn't so much tooling best practices as tips for working with it (ie it's not so much that we recommend doing these things as that you'll get weird results if you don't), but Best Practices is as good a heading as any for now.

RichieEscarez commented 5 years ago

PTAL