search

usnistgov / OSCAL-Pages

Open Security Controls Assessment Language (OSCAL) Website Content
https://pages.nist.gov/OSCAL/
Other
7 stars 14 forks source link

Add blog index section and introductory post #44

Closed aj-stein-nist closed 1 year ago

aj-stein-nist commented 1 year ago

This PR closes usnistgov/OSCAL-Pages#43 (formerly usnistgov/OSCAL#1911) and usnistgov/OSCAL-Pages #34 which existed at the time issue #43 was created.

Index:

image

First blog post:

image

aj-stein-nist commented 1 year ago

Open question, I am not sue how the sorting may work when we have more than one blog post or I need to worry about that for now, that is technically outside the scope of this issue for now.

nikitawootten-nist commented 1 year ago

@aj-stein-nist, by any chance would the blog list be separated into a separate archetype and adjusted to include a link to an RSS feed? This may be more appropriate as follow up work.

(Um, wow, not sure how I didn't pay attention and edit the comment and not post my own, haha.)

aj-stein-nist commented 1 year ago

@aj-stein-nist, by any chance would the blog list be separated into a separate archetype and adjusted to include a link to an RSS feed? This may be more appropriate as follow up work.

Embarrassed to admit that I didn't know it was a blog post archetype, I am not opposed, but can also set it up with a separate issue, I am fine either way. Let me review and follow up and update with a comment.

iMichaela commented 1 year ago

Open question, I am not sue how the sorting may work when we have more than one blog post or I need to worry about that for now, that is technically outside the scope of this issue for now.

I suggest the latest post to be on top, meaning the blogs get published in reverse order, and the last ones get collapsed under [view more] with a redirect or page expand?

iMichaela commented 1 year ago

Lessons learned from https://simplewriting.org/blog-vs-blog-post-whats-the-difference/: call the page OSCAL Blog Posts (we are publishing blog posts on OSCAL website. Might even be able to drop "OSCAL" from the title since two is implicit. A 'blog' is a particular type of website (https://www.markbrinker.com/parts-of-a-website) : " ... the difference between a blog and a website boils down to how the content is structured and presented. 1. When you publish something on a blog it’s called a post and blog posts are published in chronological order like journal entries in a diary. The origin of the word “blog” is a contraction of web log. 2. When you publish something on a website it’s called a page and web pages are not presented sequentially. They’re just a collection pages (i.e. homepage, about us page, contact page, etc) that are linked together. 3. Blog posts allow for interactivity with readers via comments. Standard web pages don’t have a commenting section. 4. Web pages are usually informational in nature about a company’s products or services. They tend to use a bit more formal and official sounding language. Blog posts have a more casual and conversational tone. A blog can be a standalone website or it can be a section of a larger website."

aj-stein-nist commented 1 year ago

Open question, I am not sue how the sorting may work when we have more than one blog post or I need to worry about that for now, that is technically outside the scope of this issue for now.

I suggest the latest post to be on top, meaning the blogs get published in reverse order, and the last ones get collapsed under [view more] with a redirect or page expand?

My point was that I am not sure what the inherent order will be, I have to review the archetype and how it is configured now (it could be based on name but I think it is on the filesystem datetime stamp but I have to review).

aj-stein-nist commented 1 year ago

call the page OSCAL Blog Posts (we are publishing blog posts on OSCAL website.

The reason I called the index page this is because it is the blog, and the blog contains the blog post. (And just to explain why I made it now: we need the index page for the section of the site or having more than one post will cause a directory re-org and alias fiasco.)

Might even be able to drop "OSCAL" from the title since two is implicit.

Yeah that's on me. I thought it would publish with the title not the heading, woops. That I intended to update so the HTML header and metadata said "OSCAL Blog" but what the reader sees on the screen is "Blog" (where the posts are listed).

I am making this changes and some others we discussed over the phone. I will push it up soon.

aj-stein-nist commented 1 year ago

@iMichaela please re-review, written and verbal feedback included.

aj-stein-nist commented 1 year ago

@aj-stein-nist, by any chance would the blog list be separated into a separate archetype and adjusted to include a link to an RSS feed? This may be more appropriate as follow up work.

(Um, wow, not sure how I didn't pay attention and edit the comment and not post my own, haha.)

I will add this as follow-up work (since I only see we are using the default archetype and not section-index.md I guess we can add that on the blog index and/or individual posts, but I was pleasantly surprised when running locally it already gets added to the RSS feed, but the local development and production site RSS feeds have wonky incorrect timestamps. That will become issue 2 from a result of this investigation, thanks for posting this.