grass-website
grass-website copied to clipboard
Clarify usage of layouts
Currently, there are different files in the layout directory. Some seem to be used, others not and when one looks at the files in the content directory one can find a very diverse usage of these layouts, probably stemming from massive copy-pasting for creating new pages (at least that's the case for me):
`grass-website/content$ grep --exclude-dir=news/ -R "layout:"
download/mac.en.md:layout: "os" download/docker.en.md:layout: "os" download/linux.en.md:layout: "os" download/data.en.md:layout: "data" download/addons.en.md:layout: "os" download/windows.en.md:layout: "os" about/history.md:layout: "general" about/elements.md:layout: elements about/brand.md:layout: "brand" about/license.md:layout: "overview" about/community.md:layout: "community" about/history/van-warren-notes.md:layout: "general" about/history/releases.md:layout: "general" about/history/web-evolution.md:layout: "general" about/history/gnu-release.md:layout: "general" about/credits.md:layout: "credits" contribute/development.md:layout: "devel" contribute/donations.md:layout: "general" contribute/community.md:layout: "contribute" contribute/sponsors.md:layout: "contribute" learn/books.md:layout: "overview" learn/overview.md:layout: "overview" learn/manuals.md:layout: "manuals" learn/tutorials.md:layout: "overview"`
I would need some guidance on this:
- When do we need a specific layout file ?
- If no specific layout is needed, which would be the main layout template ("general" ?)
I can answer for what I understood, but could be wrong
I would need some guidance on this:
1. When do we need a specific layout file ?
if the layout is different from a general one (for example different number of column or images in some specific place, ecc), however each content file need a layout file
2. If no specific layout is needed, which would be the main layout template ("general" ?)
this could be (at least a general template for each section "download", "learn", "about"..), but right now the website is developed in different way
This is the most clear example of why we need #57, i.e., a website contributor manual and documentation about the website structure
@mlennert is it more clear?
@mlennert is it more clear?
@lucadelu, as @veroandreo said, this is actually a call for a clear manual. The situation seems to be a bit less based on arbitrary copy-pasting of existing files now than before. But there still is no clear rule detectable for me. Ex: why do most pages in learn/ use "overview". If there is a general template for the learn section, shouldn't this better be called "learn" ? This is probably not very fundamental, just a question of documenting clearly what future contributors should adhere to.