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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: clarify where .jekyll-metadata comes from #8646

Merged
merged 2 commits into from May 14, 2021

Conversation

kmk3
Copy link
Contributor

@kmk3 kmk3 commented Apr 19, 2021

This is a 馃敠 documentation change.

Summary

In its overview section, link to the incremental regeneration page and
show how to create the file. That page is the only one that mentions
both the file by name and also how/when it gets generated (e.g.: with
the -I flag):

https://jekyllrb.com/docs/configuration/incremental-regeneration/

Context

I wanted to see if this file is ever generated (or if it was deprecated or
something) and how to do so before adding it to a .gitignore file, as I only
use jekyll serve anyway.

It took me a long while to find out how to generate it (I had to clone the repo
and grep around).

@kmk3 kmk3 changed the title docs: link to incremental regeneration docs: clarify where .jekyll-metadata comes from Apr 20, 2021
kmk3 added a commit to kmk3/jekyll that referenced this pull request Apr 20, 2021
It's currently missing from the Directory Structure page:
https://jekyllrb.com/docs/structure/

Relates to jekyll#8646
kmk3 added a commit to kmk3/jekyll that referenced this pull request Apr 20, 2021
It's currently missing from the Directory Structure page:
https://jekyllrb.com/docs/structure/

Kind of relates to jekyll#8646.
In its overview section[1], link to the incremental regeneration page[2]
and show how to create the file.  That page is the only one that
mentions both the file by name and also how/when it gets generated
(e.g.: with the `-I` flag).

[1] https://jekyllrb.com/docs/structure/
[2] https://jekyllrb.com/docs/configuration/incremental-regeneration/
kmk3 added a commit to kmk3/editorconfig.github.com that referenced this pull request Apr 20, 2021
* .jekyll-cache/: created when running e.g: `jekyll serve` [1][2]
* .jekyll-metadata: created when running e.g.: `jekyll serve -I` [1][3]

[1] https://jekyllrb.com/docs/structure/
[2] jekyll/jekyll#8648
[3] jekyll/jekyll#8646
xuhdev pushed a commit to editorconfig/editorconfig.github.com that referenced this pull request Apr 20, 2021
* .jekyll-cache/: created when running e.g: `jekyll serve` [1][2]
* .jekyll-metadata: created when running e.g.: `jekyll serve -I` [1][3]

[1] https://jekyllrb.com/docs/structure/
[2] jekyll/jekyll#8648
[3] jekyll/jekyll#8646
@DirtyF
Copy link
Member

DirtyF commented May 14, 2021

@jekyll: merge +docs

@jekyllbot jekyllbot merged commit d85c89e into jekyll:master May 14, 2021
jekyllbot added a commit that referenced this pull request May 14, 2021
github-actions bot pushed a commit that referenced this pull request May 14, 2021
Kelvin M. Klann: docs: clarify where .jekyll-metadata comes from (#8646)

Merge pull request 8646
@kmk3 kmk3 deleted the docs-link-inc-builds branch May 15, 2021 22:18
@jekyll jekyll locked and limited conversation to collaborators May 15, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants