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 the "no resources in sub folders" restriction for branch bundles #11439

Closed
Tracked by #11455 ...
bep opened this issue Sep 8, 2023 · 1 comment · Fixed by #11894
Closed
Tracked by #11455 ...

Remove the "no resources in sub folders" restriction for branch bundles #11439

bep opened this issue Sep 8, 2023 · 1 comment · Fixed by #11894

Comments

@bep
Copy link
Member

bep commented Sep 8, 2023

I'm working on some cool stuff that requires some simplifications in how we process /content files.

Currently

  • resources for branch bundles (e.g. sections, home page) need to live in the root folder of that bundle.
  • every non-content-file inside /content that's not part of a bundle gets copied to /public as it would live in /static.
content
├── _index.md
├── foo.png
└── posts
    ├── _index.md
    ├── baz.png
    ├── images
    │   ├── image1.png
    │   ├── image2.png
    │   └── image3.png
    ├── p1.md
    └── p2
        ├── bar.png
        └── index.md

Given the above example, the images in posts/images will with this proposal be part of the posts section bundle.

That will in some (rare?) setups be a breaking change but I would argue that

  1. It feels more natural and is easier to understand/document.
  2. It will probably solve more problems that it breaks.

/cc @jmooring

@bep bep added the Proposal label Sep 8, 2023
@bep bep added this to the v0.119.0 milestone Sep 8, 2023
@bep bep changed the title Remove the "no resources in sub folders" for branch bundles Remove the "no resources in sub folders" restriction for branch bundles Sep 8, 2023
@bep bep self-assigned this Sep 8, 2023
@bep bep added Enhancement and removed Proposal labels Sep 11, 2023
bep added a commit to bep/hugo that referenced this issue Sep 11, 2023
bep added a commit to bep/hugo that referenced this issue Sep 14, 2023
bep added a commit to bep/hugo that referenced this issue Sep 15, 2023
bep added a commit to bep/hugo that referenced this issue Sep 15, 2023
bep added a commit to bep/hugo that referenced this issue Sep 15, 2023
bep added a commit to bep/hugo that referenced this issue Sep 16, 2023
bep added a commit to bep/hugo that referenced this issue Sep 20, 2023
bep added a commit to bep/hugo that referenced this issue Sep 28, 2023
bep added a commit to bep/hugo that referenced this issue Sep 28, 2023
bep added a commit to bep/hugo that referenced this issue Oct 1, 2023
bep added a commit to bep/hugo that referenced this issue Oct 1, 2023
bep added a commit to bep/hugo that referenced this issue Oct 2, 2023
@bep bep modified the milestones: v0.119.0, v0.120.0 Oct 4, 2023
bep added a commit to bep/hugo that referenced this issue Oct 4, 2023
bep added a commit to bep/hugo that referenced this issue Oct 8, 2023
@bep bep modified the milestones: v0.120.0, v0.121.0 Oct 31, 2023
bep added a commit to bep/hugo that referenced this issue Jan 13, 2024
bep added a commit to bep/hugo that referenced this issue Jan 14, 2024
bep added a commit to bep/hugo that referenced this issue Jan 14, 2024
bep added a commit to bep/hugo that referenced this issue Jan 14, 2024
bep added a commit to bep/hugo that referenced this issue Jan 14, 2024
bep added a commit to bep/hugo that referenced this issue Jan 15, 2024
bep added a commit to bep/hugo that referenced this issue Jan 15, 2024
bep added a commit to bep/hugo that referenced this issue Jan 15, 2024
bep added a commit to bep/hugo that referenced this issue Jan 15, 2024
bep added a commit to bep/hugo that referenced this issue Jan 16, 2024
bep added a commit to bep/hugo that referenced this issue Jan 16, 2024
bep added a commit to bep/hugo that referenced this issue Jan 17, 2024
bep added a commit that referenced this issue Jan 19, 2024
…, and some general spring cleaning

There are some breaking changes in this commit, see #11455.

Closes #11455
Closes #11549

Fixes #10104
Fixes #10380
Fixes #10694
Fixes #11439
Fixes #11453
Fixes #11457
Fixes #11466
Fixes #11540
Fixes #11551
Fixes #11556
Fixes #11654
Fixes #11661
Fixes #11663
Fixes #11664
Fixes #11669
Fixes #11671
Fixes #11807
Fixes #11808
Fixes #11809
Fixes #11815
Fixes #11840
Fixes #11860
Fixes #11883
Fixes #7425
Fixes #7436
Fixes #7437
Fixes #7544
Fixes #7882
Fixes #8307
Fixes #8498
Fixes #8927
Fixes #9192
Fixes #9324
Fixes #9343
bep added a commit that referenced this issue Jan 24, 2024
…, and some general spring cleaning

There are some breaking changes in this commit, see #11455.

Closes #11455
Closes #11549

Fixes #10104
Fixes #10380
Fixes #10694
Fixes #11439
Fixes #11453
Fixes #11457
Fixes #11466
Fixes #11540
Fixes #11551
Fixes #11556
Fixes #11654
Fixes #11661
Fixes #11663
Fixes #11664
Fixes #11669
Fixes #11671
Fixes #11807
Fixes #11808
Fixes #11809
Fixes #11815
Fixes #11840
Fixes #11860
Fixes #11883
Fixes #7425
Fixes #7436
Fixes #7437
Fixes #7544
Fixes #7882
Fixes #8307
Fixes #8498
Fixes #8927
Fixes #9192
Fixes #9324
Fixes #9343
bep added a commit that referenced this issue Jan 24, 2024
…, and some general spring cleaning

There are some breaking changes in this commit, see #11455.

Closes #11455
Closes #11549

Fixes #10104
Fixes #10380
Fixes #10694
Fixes #11439
Fixes #11453
Fixes #11457
Fixes #11466
Fixes #11540
Fixes #11551
Fixes #11556
Fixes #11654
Fixes #11661
Fixes #11663
Fixes #11664
Fixes #11669
Fixes #11671
Fixes #11807
Fixes #11808
Fixes #11809
Fixes #11815
Fixes #11840
Fixes #11860
Fixes #11883
Fixes #7425
Fixes #7436
Fixes #7437
Fixes #7544
Fixes #7882
Fixes #8307
Fixes #8498
Fixes #8927
Fixes #9192
Fixes #9324
Fixes #9343
bep added a commit that referenced this issue Jan 24, 2024
…d some general spring cleaning

There are some breaking changes in this commit, see #11455.

Closes #11455
Closes #11549

Fixes #10104
Fixes #10380
Fixes #10694
Fixes #11439
Fixes #11453
Fixes #11457
Fixes #11466
Fixes #11540
Fixes #11551
Fixes #11556
Fixes #11654
Fixes #11661
Fixes #11663
Fixes #11664
Fixes #11669
Fixes #11671
Fixes #11807
Fixes #11808
Fixes #11809
Fixes #11815
Fixes #11840
Fixes #11860
Fixes #11883
Fixes #7425
Fixes #7436
Fixes #7437
Fixes #7544
Fixes #7882
Fixes #8307
Fixes #8498
Fixes #8927
Fixes #9192
Fixes #9324
Fixes #9343
bep added a commit that referenced this issue Jan 25, 2024
…d some general spring cleaning

There are some breaking changes in this commit, see #11455.

Closes #11455
Closes #11549

Fixes #10104
Fixes #10380
Fixes #10694
Fixes #11439
Fixes #11453
Fixes #11457
Fixes #11466
Fixes #11540
Fixes #11551
Fixes #11556
Fixes #11654
Fixes #11661
Fixes #11663
Fixes #11664
Fixes #11669
Fixes #11671
Fixes #11807
Fixes #11808
Fixes #11809
Fixes #11815
Fixes #11840
Fixes #11860
Fixes #11883
Fixes #7425
Fixes #7436
Fixes #7437
Fixes #7544
Fixes #7882
Fixes #8307
Fixes #8498
Fixes #8927
Fixes #9192
Fixes #9324
Fixes #9343
bep added a commit that referenced this issue Jan 26, 2024
…d some general spring cleaning

There are some breaking changes in this commit, see #11455.

Closes #11455
Closes #11549

Fixes #10169
Fixes #10364
Fixes #10482
Fixes #10630
Fixes #10656
Fixes #10694
Fixes #10918
Fixes #11262
Fixes #11439
Fixes #11453
Fixes #11457
Fixes #11466
Fixes #11540
Fixes #11551
Fixes #11556
Fixes #11654
Fixes #11661
Fixes #11663
Fixes #11664
Fixes #11669
Fixes #11671
Fixes #11807
Fixes #11808
Fixes #11809
Fixes #11815
Fixes #11840
Fixes #11853
Fixes #11860
Fixes #11883
Fixes #11904
Fixes #7388
Fixes #7425
Fixes #7436
Fixes #7544
Fixes #7882
Fixes #7960
Fixes #8255
Fixes #8307
Fixes #8863
Fixes #8927
Fixes #9192
Fixes #9324
bep added a commit that referenced this issue Jan 27, 2024
…d some general spring cleaning

There are some breaking changes in this commit, see #11455.

Closes #11455
Closes #11549

Fixes #10169
Fixes #10364
Fixes #10482
Fixes #10630
Fixes #10656
Fixes #10694
Fixes #10918
Fixes #11262
Fixes #11439
Fixes #11453
Fixes #11457
Fixes #11466
Fixes #11540
Fixes #11551
Fixes #11556
Fixes #11654
Fixes #11661
Fixes #11663
Fixes #11664
Fixes #11669
Fixes #11671
Fixes #11807
Fixes #11808
Fixes #11809
Fixes #11815
Fixes #11840
Fixes #11853
Fixes #11860
Fixes #11883
Fixes #11904
Fixes #7388
Fixes #7425
Fixes #7436
Fixes #7544
Fixes #7882
Fixes #7960
Fixes #8255
Fixes #8307
Fixes #8863
Fixes #8927
Fixes #9192
Fixes #9324
bep added a commit that referenced this issue Jan 27, 2024
…d some general spring cleaning

There are some breaking changes in this commit, see #11455.

Closes #11455
Closes #11549

This fixes a set of bugs (see issue list) and it is also paying some technical debt accumulated over the years. We now build with Staticcheck enabled in the CI build.

The performance should be about the same as before for regular sized Hugo sites, but it should perform and scale much better to larger data sets, as objects that uses lots of memory (e.g. rendered Markdown, big JSON files read into maps with transform.Unmarshal etc.) will now get automatically garbage collected if needed. Performance on partial rebuilds when running the server in fast render mode should be the same, but the change detection should be much more accurate.

A list of the notable new features:

* A new dependency tracker that covers (almost) all of Hugo's API and is used to do fine grained partial rebuilds when running the server.
* A new and simpler tree document store which allows fast lookups and prefix-walking in all dimensions (e.g. language) concurrently.
* You can now configure an upper memory limit allowing for much larger data sets and/or running on lower specced PCs.
We have lifted the "no resources in sub folders" restriction for branch bundles (e.g. sections).
Memory Limit
* Hugos will, by default, set aside a quarter of the total system memory, but you can set this via the OS environment variable HUGO_MEMORYLIMIT (in gigabytes). This is backed by a partitioned LRU cache used throughout Hugo. A cache that gets dynamically resized in low memory situations, allowing Go's Garbage Collector to free the memory.

New Dependency Tracker: Hugo has had a rule based coarse grained approach to server rebuilds that has worked mostly pretty well, but there have been some surprises (e.g. stale content). This is now revamped with a new dependency tracker that can quickly calculate the delta given a changed resource (e.g. a content file, template, JS file etc.). This handles transitive relations, e.g. $page -> js.Build -> JS import, or $page1.Content -> render hook -> site.GetPage -> $page2.Title, or $page1.Content -> shortcode -> partial -> site.RegularPages -> $page2.Content -> shortcode ..., and should also handle changes to aggregated values (e.g. site.Lastmod) effectively.

This covers all of Hugo's API with 2 known exceptions (a list that may not be fully exhaustive):

Changes to files loaded with template func os.ReadFile may not be handled correctly. We recommend loading resources with resources.Get
Changes to Hugo objects (e.g. Page) passed in the template context to lang.Translate may not be detected correctly. We recommend having simple i18n templates without too much data context passed in other than simple types such as strings and numbers.
Note that the cachebuster configuration (when A changes then rebuild B) works well with the above, but we recommend that you revise that configuration, as it in most situations should not be needed. One example where it is still needed is with TailwindCSS and using changes to hugo_stats.json to trigger new CSS rebuilds.

Document Store: Previously, a little simplified, we split the document store (where we store pages and resources) in a tree per language. This worked pretty well, but the structure made some operations harder than they needed to be. We have now restructured it into one Radix tree for all languages. Internally the language is considered to be a dimension of that tree, and the tree can be viewed in all dimensions concurrently. This makes some operations re. language simpler (e.g. finding translations is just a slice range), but the idea is that it should also be relatively inexpensive to add more dimensions if needed (e.g. role).

Fixes #10169
Fixes #10364
Fixes #10482
Fixes #10630
Fixes #10656
Fixes #10694
Fixes #10918
Fixes #11262
Fixes #11439
Fixes #11453
Fixes #11457
Fixes #11466
Fixes #11540
Fixes #11551
Fixes #11556
Fixes #11654
Fixes #11661
Fixes #11663
Fixes #11664
Fixes #11669
Fixes #11671
Fixes #11807
Fixes #11808
Fixes #11809
Fixes #11815
Fixes #11840
Fixes #11853
Fixes #11860
Fixes #11883
Fixes #11904
Fixes #7388
Fixes #7425
Fixes #7436
Fixes #7544
Fixes #7882
Fixes #7960
Fixes #8255
Fixes #8307
Fixes #8863
Fixes #8927
Fixes #9192
Fixes #9324
bep added a commit that referenced this issue Jan 27, 2024
…d some general spring cleaning

There are some breaking changes in this commit, see #11455.

Closes #11455
Closes #11549

This fixes a set of bugs (see issue list) and it is also paying some technical debt accumulated over the years. We now build with Staticcheck enabled in the CI build.

The performance should be about the same as before for regular sized Hugo sites, but it should perform and scale much better to larger data sets, as objects that uses lots of memory (e.g. rendered Markdown, big JSON files read into maps with transform.Unmarshal etc.) will now get automatically garbage collected if needed. Performance on partial rebuilds when running the server in fast render mode should be the same, but the change detection should be much more accurate.

A list of the notable new features:

* A new dependency tracker that covers (almost) all of Hugo's API and is used to do fine grained partial rebuilds when running the server.
* A new and simpler tree document store which allows fast lookups and prefix-walking in all dimensions (e.g. language) concurrently.
* You can now configure an upper memory limit allowing for much larger data sets and/or running on lower specced PCs.
We have lifted the "no resources in sub folders" restriction for branch bundles (e.g. sections).
Memory Limit
* Hugos will, by default, set aside a quarter of the total system memory, but you can set this via the OS environment variable HUGO_MEMORYLIMIT (in gigabytes). This is backed by a partitioned LRU cache used throughout Hugo. A cache that gets dynamically resized in low memory situations, allowing Go's Garbage Collector to free the memory.

New Dependency Tracker: Hugo has had a rule based coarse grained approach to server rebuilds that has worked mostly pretty well, but there have been some surprises (e.g. stale content). This is now revamped with a new dependency tracker that can quickly calculate the delta given a changed resource (e.g. a content file, template, JS file etc.). This handles transitive relations, e.g. $page -> js.Build -> JS import, or $page1.Content -> render hook -> site.GetPage -> $page2.Title, or $page1.Content -> shortcode -> partial -> site.RegularPages -> $page2.Content -> shortcode ..., and should also handle changes to aggregated values (e.g. site.Lastmod) effectively.

This covers all of Hugo's API with 2 known exceptions (a list that may not be fully exhaustive):

Changes to files loaded with template func os.ReadFile may not be handled correctly. We recommend loading resources with resources.Get
Changes to Hugo objects (e.g. Page) passed in the template context to lang.Translate may not be detected correctly. We recommend having simple i18n templates without too much data context passed in other than simple types such as strings and numbers.
Note that the cachebuster configuration (when A changes then rebuild B) works well with the above, but we recommend that you revise that configuration, as it in most situations should not be needed. One example where it is still needed is with TailwindCSS and using changes to hugo_stats.json to trigger new CSS rebuilds.

Document Store: Previously, a little simplified, we split the document store (where we store pages and resources) in a tree per language. This worked pretty well, but the structure made some operations harder than they needed to be. We have now restructured it into one Radix tree for all languages. Internally the language is considered to be a dimension of that tree, and the tree can be viewed in all dimensions concurrently. This makes some operations re. language simpler (e.g. finding translations is just a slice range), but the idea is that it should also be relatively inexpensive to add more dimensions if needed (e.g. role).

Fixes #10169
Fixes #10364
Fixes #10482
Fixes #10630
Fixes #10656
Fixes #10694
Fixes #10918
Fixes #11262
Fixes #11439
Fixes #11453
Fixes #11457
Fixes #11466
Fixes #11540
Fixes #11551
Fixes #11556
Fixes #11654
Fixes #11661
Fixes #11663
Fixes #11664
Fixes #11669
Fixes #11671
Fixes #11807
Fixes #11808
Fixes #11809
Fixes #11815
Fixes #11840
Fixes #11853
Fixes #11860
Fixes #11883
Fixes #11904
Fixes #7388
Fixes #7425
Fixes #7436
Fixes #7544
Fixes #7882
Fixes #7960
Fixes #8255
Fixes #8307
Fixes #8863
Fixes #8927
Fixes #9192
Fixes #9324
@bep bep modified the milestones: v0.122.0, v0.123.0 Jan 27, 2024
@bep bep closed this as completed in e39c0f4 Jan 28, 2024
Copy link

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 19, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.