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

Remove confusion in docs #22

Merged
merged 5 commits into from
Oct 11, 2018
Merged

Remove confusion in docs #22

merged 5 commits into from
Oct 11, 2018

Conversation

coolshaurya
Copy link
Contributor

fixes issue 268 in 11ty/eleventy

@kleinfreund
Copy link
Contributor

Hey. Hm, I’m not too happy with either the current version or your proposed version.

First of all, the includes directory is not meant for data in general. That purpose is served by data files which are a different concept.

What do you think about the following?

- Controls the directory inside which the template includes/extends/partials/etc can be found.
+ Controls the directory inside which the templates, extends, partials or other includes can be found.

(For reference, the discussion around this started in 11ty/eleventy#268.)

docs/config.md Outdated
@@ -108,7 +108,7 @@ module.exports = {

### Directory for Includes

Controls the directory inside which the template includes/extends/partials/etc can be found.
Controls which directory is the _includes_ directory. The _includes_ directory is meant for templates and data in general, like layout templates.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure it is meant for 'data in general'. Is it?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, it is not.
What I meant was template data in general. I wrote it in a hurry.

@zachleat
Copy link
Member

zachleat commented Oct 6, 2018

Controls which directory is the includes directory. The includes directory is meant for templates, extends, partials or other includes like macros and brand assets.

I think we can get rid of this line, seems redundant?

Controls which directory is the includes directory.

I like what you’re going for here, I wonder if it would be better like this?

The includes directory is meant for templates include files, extends files, partials, or macros. These files will not be processed as Eleventy templates, but can be consumed by other templates.

@coolshaurya
Copy link
Contributor Author

@zachleat ,We can certainly get rid of that line.

Removing 'templates' form that line can still cause confusion as layout templates are stored in the includes directory too.

@zachleat
Copy link
Member

zachleat commented Oct 8, 2018

How are you defining a template? To me a template is any string using template syntax—it could be content, an include, macro, partial, layout, anything.

To say something is a template doesn’t really give any extra context about what that thing is?

@zachleat
Copy link
Member

zachleat commented Oct 8, 2018

See also #24

@coolshaurya
Copy link
Contributor Author

What about this -

The includes directory is meant for layout templates, include files, extends files, partials, or macros. These files will not be processed as input files, but can be consumed by other templates.

@zachleat
Copy link
Member

Yes I like that a lot @coolshaurya!

@coolshaurya
Copy link
Contributor Author

Done - changes committed

@zachleat zachleat merged commit e3ddd7f into 11ty:master Oct 11, 2018
@zachleat
Copy link
Member

Shipped! Thanks for iterating on this!

@coolshaurya coolshaurya deleted the patch-3 branch October 11, 2018 17:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants