Skip to content

Implement the concept of "page", with a dedicated "pages" folder like Jekyll #25

Closed
Closed
Implement the concept of "page", with a dedicated "pages" folder like Jekyll#25

Description

@rdeago
rdeago
opened on Oct 26, 2022

Background and motivation

The upstream project distinguishes between a "post" a "page" and a... "neither-post-nor-page", let's call it "infrastructure" (home, posts, tags).

As far as I can tell, the only current difference between the three kinds of pages should be the CSS class of the title / description <div>: post-heading for posts, page-heading for pages, site-heading for infrastructure. However, the conceptual distinction is more important than just the CSS class, because the StartBootstrap team may decide to, say, use different masthead colors for posts and pages, and we wouldn't be able to implement that if we can't tell what a "page" is.

#23 adds an IsArchive setting which is similar in purpose (a "neither-post-nor-archive" is a "page") but an IsPage setting would probably make more sense, as it maps easily to the concept of "page" in Jekyll, Wordpress, and probably others.

Implementation

  • Remove the IsArchive setting (I could do this directly in Update dependencies, refactor styles and scripts, add some goodies #23 before it gets merged).
  • Add a pages folder under input with an about.md file (that will be overridden by users) to demonstrate the feature. (EDIT: no sense in forcing a page to exist on user sites; a decently-written section in README will do)
  • Add PageSources and IsPage settings in settings.yml:
PageSources: pages/**/*
IsPage: => Outputs.FilterSources(Context.GetString("PageSources")).ContainsById(Document)
  • Change line 16 of _header.cshtml from this:
        <div class="@(isPost ? "post-heading" : "site-heading")">

to this:

        <div class="@(isPost ? "post-heading" : isPage ? "page-heading" : "site-heading")">

Styling for the page-heading class is already implemented and imported, we just never got to see it so far.

  • Make all other necessary changes wherever IsArchive was used to tell apart pages from infrastructure.

Incompatibilities

An existing blog's "About" page will not see any changes, unless the author adds IsPage: true to front matter.

If an author wants to keep existing pages in input they have to exclude the pages folder from processing; it shouldn't be hard AFAIK, but I'd advise moving pages under pages and using redirects instead.

@daveaglick any thoughts? Should I add this to #23 instead of the IsArchive mess (admittedly of my creation)?

Activity

  1. rdeago
    changed the title [-]Implement the concept of "page", _à la_ Jekyll[/-] [+]Implement the concept of "page", with a dedicated "pages" folder like Jekyll[/+] on Oct 26, 2022
  2. rdeago
    added a commit that references this issue on Oct 28, 2022

    Replace support for IsArchive metadata with support for IsPage

    875b1f1

  3. rdeago commented on Oct 28, 2022

    @rdeago
    rdeago
    on Oct 28, 2022
    ContributorAuthor

    Changes already pushed to #23. @daveaglick I'm sorry for not even waiting for your reply, but the IsArchive hack just had to die.

  4. atiq-cs commented on Nov 30, 2022

    @atiq-cs
    atiq-cs
    on Nov 30, 2022
    Contributor

    ditto: multiple PRs with small amount of changes is much better

  5. rdeago commented on Dec 1, 2022

    @rdeago
    rdeago
    on Dec 1, 2022
    ContributorAuthor

    @atiq-cs I fail to see how this issue could be split. The bullet points under "Implementation" make little to no sense if singled out.

    Anyway, this issue is moot since the problem was created halfway in #23 and the fix is already in a later commit in #23. Even if #23 gets abandoned in favor of smaller PRs, I'll just avoid creating the problem in the first place.

  6. rdeago
    closed this as completedon Dec 1, 2022
  7. daveaglick
    added a commit that references this issue on Dec 5, 2022

    Replace support for IsArchive metadata with support for IsPage

    8c248f0

  8. atiq-cs commented on Aug 6, 2023

    @atiq-cs
    atiq-cs
    on Aug 6, 2023
    Contributor

    Hi Guys,
    It's been a while. Hope you are doing great!

    Change in this commit 8c248f0 as part of this PR has regressed build performance. As a result of that, our large blog with 819 posts has started failing since pulling in this change. Our blog successfully builds till commit 8c248f0 is pulled.

    To provide more context, our blog usually builds in 6 minutes. Since pulling this change / commit 8c248f0 it has been building for forever. It's also failing on the cloud instance since pulling in this change due to time outs. I request re-reviewing the change introduced and what changed that increased build time dramatically!

    Please let me know if you need any other debug / diagnostic info.

    Here's output of -- preview,

    dotnet run -- preview
[INFO] Statiq Framework version 1.0.0-beta.70+625bd4754bf14f3c6a860587c6d747f4850b1c13
[INFO] Statiq Web version 1.0.0+7f3b58623a7e4ad2542635168bf49d12bb09c299
[INFO] Root path:
       D:/Code/statiq/triage.rdeago
[INFO] Input path(s):
       theme/input
       input
[INFO] Output path:
       output
[INFO] Temp path:
       temp
[INFO] Cache path:
       cache
[INFO] ========== Execution ==========
[INFO] Executing 11 pipelines (AnalyzeContent, Archives, Assets, Content, Data, DirectoryMetadata, Feeds, Inputs, Redirects, SearchIndex, Sitemap)
[INFO] Absolute Execution Date/Time: 2023-08-06 14:32:52
[INFO] Configured Current Date/Time: 2023-08-06 14:32:52
[INFO] Minimum Configured Log Level: Information
[INFO] Cleaned temp directory D:/Code/statiq/triage.rdeago/temp
[INFO] Restored write tracking data from D:/Code/statiq/triage.rdeago/cache/writecache.json
[INFO] Restored Razor compilation cache from D:/Code/statiq/triage.rdeago/cache/razorcache.json with 825 assemblies
[INFO] -> Inputs/Input » Starting Inputs Input phase execution... (0 input document(s), 1 module(s))
[INFO] -> DirectoryMetadata/Input » Starting DirectoryMetadata Input phase execution... (0 input document(s), 1 module(s))
[INFO] <- DirectoryMetadata/Input » Finished DirectoryMetadata Input phase execution (0 output document(s), 217 ms)
[INFO] -> DirectoryMetadata/Process » Starting DirectoryMetadata Process phase execution... (0 input document(s), 1 module(s))
[INFO] <- DirectoryMetadata/Process » Finished DirectoryMetadata Process phase execution (0 output document(s), 1 ms)
[INFO] <- Inputs/Input » Finished Inputs Input phase execution (837 output document(s), 423 ms)
[INFO] -> Inputs/Process » Starting Inputs Process phase execution... (837 input document(s), 8 module(s))
[INFO] <- Inputs/Process » Finished Inputs Process phase execution (836 output document(s), 6106 ms)
[INFO] -> Data/Process » Starting Data Process phase execution... (0 input document(s), 5 module(s))
[INFO] -> Assets/Process » Starting Assets Process phase execution... (0 input document(s), 3 module(s))
[INFO] <- Data/Process » Finished Data Process phase execution (0 output document(s), 29 ms)
[INFO] -> Content/Process » Starting Content Process phase execution... (0 input document(s), 4 module(s))
[INFO] <- Content/Process » Finished Content Process phase execution (809 output document(s), 2407 ms)
[INFO] -> Archives/Process » Starting Archives Process phase execution... (0 input document(s), 3 module(s))
[INFO] <- Assets/Process » Finished Assets Process phase execution (23 output document(s), 3453 ms)
[INFO] <- Archives/Process » Finished Archives Process phase execution (880 output document(s), 87658 ms)
[INFO] -> Feeds/Process » Starting Feeds Process phase execution... (0 input document(s), 3 module(s))
[INFO] <- Feeds/Process » Finished Feeds Process phase execution (2 output document(s), 32270 ms)
[INFO] -> SearchIndex/PostProcess » Starting SearchIndex PostProcess phase execution... (0 input document(s), 1 module(s))
[INFO] <- SearchIndex/PostProcess » Finished SearchIndex PostProcess phase execution (0 output document(s), 0 ms)
[INFO] -> SearchIndex/Output » Starting SearchIndex Output phase execution... (0 input document(s), 1 module(s))
[INFO] <- SearchIndex/Output » Finished SearchIndex Output phase execution (0 output document(s), 3 ms)
[INFO] -> Sitemap/PostProcess » Starting Sitemap PostProcess phase execution... (0 input document(s), 1 module(s))
[INFO] -> Assets/Output » Starting Assets Output phase execution... (23 input document(s), 2 module(s))
[INFO] -> Data/Output » Starting Data Output phase execution... (0 input document(s), 2 module(s))
[INFO] <- Data/Output » Finished Data Output phase execution (0 output document(s), 0 ms)
[INFO] -> Content/PostProcess » Starting Content PostProcess phase execution... (809 input document(s), 1 module(s))
[INFO] <- Assets/Output » Finished Assets Output phase execution (23 output document(s), 36 ms)
[INFO] -> Archives/PostProcess » Starting Archives PostProcess phase execution... (880 input document(s), 1 module(s))
[INFO] -> Feeds/Output » Starting Feeds Output phase execution... (2 input document(s), 2 module(s))
[INFO] <- Feeds/Output » Finished Feeds Output phase execution (2 output document(s), 4 ms)
[INFO] <- Sitemap/PostProcess » Finished Sitemap PostProcess phase execution (1 output document(s), 99 ms)
[INFO] -> Sitemap/Output » Starting Sitemap Output phase execution... (1 input document(s), 1 module(s))
[INFO] <- Sitemap/Output » Finished Sitemap Output phase execution (1 output document(s), 7 ms)
[INFO] [Microsoft.AspNetCore.DataProtection.KeyManagement.XmlKeyManager] User profile is available. Using 'C:\Users\Atiq\AppData\Local\ASP.NET\DataProtection-Keys' as key repository and Windows DPAPI to encrypt keys at rest.

  9. atiq-cs commented on Aug 6, 2023

    @atiq-cs
    atiq-cs
    on Aug 6, 2023
    Contributor

    @daveaglick need to re-open this issue please if it makes sense from above!

  10. rdeago commented on Aug 8, 2023

    @rdeago
    rdeago
    on Aug 8, 2023
    ContributorAuthor

    @atiq-cs reopening this issue months after the fact wouldn't do much good IMHO, so I took the liberty of copying your post to new issue #34. If a fix is needed, it's better applied via a new PR at this point.

  11. atiq-cs
    added 2 commits that reference this issue on Sep 25, 2023

    Disable IsPage till perf regression is fixed

    ab938d2

    Disable IsPage till perf regression is fixed

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions