Repository navigation
Introduce a "Guides" page to collect timeless content - #354
Open
sebastianbergmann wants to merge 5 commits into
Open
sebastianbergmann wants to merge 5 commits into
sebastianbergmann wants to merge 5 commits into
Conversation
Blog posts are listed in reverse chronological order, which makes timeless content such as guides hard to find once newer posts have been published. The new /guides page lists every blog post whose front matter has a `guide` key, grouped into the sections defined at the top of the page. The posts themselves remain blog posts at their existing URLs.
"How to Contribute to PHP" goes into the "Contributing to PHP" section, "So You Received a Security Report. Now What?" and "Your Tool Has a New Reader" go into the "Maintaining PHP projects" section.
Readers who arrive at a guide through the blog, a feed, or a search engine learn that more guides exist and where to find them.
Contributor
|
🚀 Deployed on https://deploy-pr-354--thephpfoundation.netlify.app |
Contributor
|
@mattstauffer I think the Guide on Contributing might be redundant given the new "Get Involved" page, but I would feel better about you reviewing this to make sure there aren't any collisions or conflicts with what you have open right now. |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #338
Timeless content such as guides is currently only published as blog posts under "News". Because the blog is sorted by date, these posts become hard to find once newer posts have been published.
This pull request adds a Guides page, as suggested in #338. The page lists those posts by topic instead of by date. The posts remain blog posts: their URLs do not change, and they still appear under News, on the tag pages, and in the Atom feed.
Changes
/guidespage (source/_pages/guides.html): lists every blog post whose front matter has aguidekey, grouped into sections. Each entry shows the post's title, description, publication date, and authors.guidekey shows "This post is part of our Guides", linking to its section of the Guides page.Adding a guide
Add a
guidekey to the post's front matter, using the key of one of the sections defined at the top ofsource/_pages/guides.html:To add a new section, add an entry with a title and an intro to the
sectionsmap insource/_pages/guides.html. Sections that contain no posts are not shown.Open questions
guide_orderkey.