USWDS-Site - What's new: Add README to posts directory #3047
Conversation
|
Hi @amyleadem , does this need a FFR to publish? I'm going to start to add posts. |
|
Let's hold off on publishing this README until you are able to successfully complete the process a couple times first. Once you can successfully build a couple different kinds of posts and we confirm the README has everything it needs, then we can move this to review and FFR. |
…ats-new-readme
amyleadem
requested review from
mejiaj,
mahoneycm,
finekatie and
cathybaptista
and removed request for
cathybaptista,
mejiaj,
mahoneycm and
finekatie
|
Hi @amyleadem , I wanted to ask about the posts_short README - should there be some notes about when we don't want to link to anything from the header at all, like we are for that one post about sunsetting 1.0? I don't see anything currently... |
|
@finekatie The short posts README has an example implementation of a short post with no header link in these lines, and also a note in the data key table about setting
|
There was a problem hiding this comment.
@amyleadem thanks for bringing this back!
Left some comments for plain language, clarity, and reducing content duplication.
_posts/README.md
Outdated
|
|
||
| The feed on our [What's new page](https://designsystem.digital.gov/about/whats-new/) is powered by the files in two different directories: | ||
| - `/_posts`: These are the long format posts generated by [Jekyll posts](https://jekyllrb.com/docs/posts/). These files will automatically generate both a post preview for the news feed and a separate page for the post content. | ||
| - See the instructions in this document to learn how to [create a new post](#creating-a-new-post), [customize a post's metadata](#customizing-post-metadata), and follow [post conventions](#post-conventions). |
There was a problem hiding this comment.
Suggestion: We should move this instructions bullet to the "Creating a new post" section.
There was a problem hiding this comment.
Good call. That sentence does feel out of place. I ended up moving this sentence into a new intro section at the top. Hoping it makes the file make a bit more sense. Let me know what you think.
_posts/README.md
Outdated
| author: | ||
| tags: | ||
| --- | ||
|
|
There was a problem hiding this comment.
thought: We should consider a link to a markdown guide. Probably future enhancement.
There was a problem hiding this comment.
Added a link to the basic markdown syntax in 1c76c3f
| And this is another paragraph. | ||
| ``` | ||
|
|
||
| ## Customizing post metadata |
There was a problem hiding this comment.
polish: This section could be moved up as part of the frontmatter example.
There was a problem hiding this comment.
If we're repeating documentation, perhaps the general README is the best place for it.
Folder specific guidance should live here.
There was a problem hiding this comment.
I moved some of the content into the repo's main README in 6fc6de4.
Co-authored-by: James Mejia <[email protected]>
…ats-new-readme
|
@mejiaj I made some updates to the organization of these READMEs and incorporated many of your copy suggestions. This is ready for re-review. |
Summary
Added READMEs to the
_postsand_posts_shortdirectories. These READMEs provide instructions for creating new posts on the what's new page.Important
These READMEs rely on the updates added in PR #3064, which has not been merged into
mainat the time of this comment. If that PR is still in progress, use the related branch (al-whats-new-directory-change) to test the instructions here.Related issue
Closes #2987
Preview link
Problem statement
We do not currently offer instructions for creating items for the "what's new" page news feed.
Solution
Create READMEs for both the
/_postsand/_posts_shortdirectory.Testing and review