[go: up one dir, main page]
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.

Sign up for GitHub

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

Jump to bottom

Clarify usage of layouts #85

Open
mlennert opened this issue Apr 6, 2020 · 4 comments
Open

Clarify usage of layouts #85

mlennert opened this issue Apr 6, 2020 · 4 comments
Assignees
@nbozon

Comments

@mlennert
Copy link
Contributor
mlennert commented Apr 6, 2020

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:

  1. When do we need a specific layout file ?
  2. If no specific layout is needed, which would be the main layout template ("general" ?)
@lucadelu
Copy link
Contributor
lucadelu commented Apr 6, 2020

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

@veroandreo
Copy link
Contributor

This is the most clear example of why we need #57, i.e., a website contributor manual and documentation about the website structure

@lucadelu
Copy link
Contributor

@mlennert is it more clear?

@lucadelu lucadelu reopened this Apr 30, 2020
@veroandreo veroandreo assigned veroandreo and nbozon and unassigned veroandreo May 3, 2020
@mlennert
Copy link
Contributor Author
mlennert commented May 4, 2020

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@nbozon nbozon

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@lucadelu @nbozon @mlennert @veroandreo