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

Add blog index section and introductory post #44

Merged
merged 13 commits into from
Sep 19, 2023

Conversation

aj-stein-nist
Copy link
Collaborator

@aj-stein-nist aj-stein-nist commented Sep 19, 2023

This PR closes #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 and others added 2 commits September 19, 2023 10:07
Co-authored-by: Arminta Jenkins <michaela.iorga@nist.gov>
Co-authored-by: Michaela Iorga <michaela.iorga@nist.gov>
Co-authored-by: Wendell Piez <wendell.piez@nist.gov>
@aj-stein-nist aj-stein-nist requested a review from a team September 19, 2023 14:18
@aj-stein-nist aj-stein-nist marked this pull request as ready for review September 19, 2023 14:22
@aj-stein-nist
Copy link
Collaborator Author

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
Copy link
Collaborator

nikitawootten-nist commented Sep 19, 2023

@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
Copy link
Collaborator Author

@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
Copy link
Contributor

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?

@aj-stein-nist aj-stein-nist changed the base branch from main to develop September 19, 2023 16:51
@iMichaela
Copy link
Contributor

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
Copy link
Collaborator Author

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
Copy link
Collaborator Author

aj-stein-nist commented Sep 19, 2023

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
Copy link
Collaborator Author

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

Take feedback with wording improvements and mentioning of a simpler build process.

Co-authored-by: Nikita Wootten <nikita.wootten@nist.gov>
src/content/about/blog/oscal-first-deep-cleaning.md Outdated Show resolved Hide resolved
src/content/about/blog/oscal-first-deep-cleaning.md Outdated Show resolved Hide resolved
src/content/about/blog/oscal-first-deep-cleaning.md Outdated Show resolved Hide resolved
src/content/about/blog/oscal-first-deep-cleaning.md Outdated Show resolved Hide resolved
@aj-stein-nist
Copy link
Collaborator Author

@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.

Remove more casual language that was not concise enough.
It is not exactly the same thing, but it can be considered redundant, so
now remove it.
@aj-stein-nist aj-stein-nist merged commit 1e60bcc into develop Sep 19, 2023
1 check passed
@aj-stein-nist aj-stein-nist linked an issue Sep 19, 2023 that may be closed by this pull request
aj-stein-nist added a commit that referenced this pull request Sep 21, 2023
* Add blog section index.

* Add edited blog post for usnistgov/OSCAL#1911.

Co-authored-by: Arminta Jenkins <michaela.iorga@nist.gov>
Co-authored-by: Michaela Iorga <michaela.iorga@nist.gov>
Co-authored-by: Wendell Piez <wendell.piez@nist.gov>

* PR feedback: correct blog index heading.

* PR feedback: shorten title, stick to fall cleaning.

* PR feedback: community->all, all is confusing.

* PR feedback: switch from deep to fall cleaning in 1st para.

* PR feedback: update changes list to include XSLT converter artifact summary, as requested.

* PR feedback: add summary about oscal-tools and oscal-cat

As requested, do this so that the distinction between release artifacts,
what metaschema-xslt does, and what higher-level transformations that
were in oscal-tools is more clear.

* Take Nikita's feedback on changes list

Take feedback with wording improvements and mentioning of a simpler build process.

Co-authored-by: Nikita Wootten <nikita.wootten@nist.gov>

* PR feedback: remove contraction.

* PR feedback: add mention of v1.1.1 also.

* PR feedback: be explicit and repeat mention of OSCAL repo

Remove more casual language that was not concise enough.

---------

Co-authored-by: Arminta Jenkins <michaela.iorga@nist.gov>
Co-authored-by: Wendell Piez <wendell.piez@nist.gov>
Co-authored-by: Nikita Wootten <nikita.wootten@nist.gov>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Publish introductory blog post OSCAL Blog page
3 participants