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

Publish introductory blog post #43

Closed
6 tasks done
aj-stein-nist opened this issue Aug 29, 2023 · 7 comments · Fixed by #44
Closed
6 tasks done

Publish introductory blog post #43

aj-stein-nist opened this issue Aug 29, 2023 · 7 comments · Fixed by #44
Assignees
Labels
enhancement New feature or request

Comments

@aj-stein-nist
Copy link
Collaborator

aj-stein-nist commented Aug 29, 2023

User Story

As an OSCAL community member, in order to get important information outside of model resources and technical documentation, I would like a series of editorialized articles about important project updates by staff and usage of OSCAL by staff and community.

NOTE: To start, we will begin with a first blog post introducing the blog, the background of the site organization to improve development work separately of website communication, and solicit topics or volunteer authors from the larger community.

Goals

  • Introduce blog with a post to explain
    • the site reorganization and how it aids such needed communication
    • how NIST staff post as needed and how we will solicit post ideas and guest authorship
    • how we need to communicate information outside of reference docs

Dependencies

  • @aj-stein-nist and @iMichaela to draft the first post, then assigned developer can publish no later than the end of the sprint

Acceptance Criteria

  • All OSCAL website and readme documentation affected by the changes in this issue have been updated. Changes to the OSCAL website can be made in the docs/content directory of your branch.
  • A Pull Request (PR) is submitted that fully addresses the goals of this User Story. This issue is referenced in the PR.
  • The CI-CD build process runs without any reported errors on the PR. This can be confirmed by reviewing that all checks have passed in the PR.

(For reviewers: The wiki has guidance on code review and overall issue review for completeness.)

Revisions

  1. @aj-stein-nist removed an AC regarding communicating outside the reference documentation, this was not achievable in the first post by the authors.
@aj-stein-nist aj-stein-nist added the enhancement New feature or request label Aug 29, 2023
@iMichaela iMichaela changed the title Publish introductory blog post Publish introductory blog post #1 Sep 5, 2023
@iMichaela iMichaela changed the title Publish introductory blog post #1 Publish introductory blog post Sep 5, 2023
@iMichaela
Copy link
Contributor

A HackMD file was created and some initial content was included. @Arminta-Jenkins-NIST and @aj-stein-nist - please feel free to continue/change/comment. https://hackmd.io/@3oiloo_VSrOgO1isWbZTmw/r1VjEySCh

@Arminta-Jenkins-NIST Arminta-Jenkins-NIST self-assigned this Sep 7, 2023
@aj-stein-nist
Copy link
Collaborator Author

Michaela and Arminta will do some touch-ups. A.J. committed to a review earlier this morning, and still needs to complete that and work to complete with the others assigned.

@aj-stein-nist
Copy link
Collaborator Author

@aj-stein-nist to schedule time with Michaela and other draft contributors to finalize draft and publish, potentially Friday or Monday.

@aj-stein-nist
Copy link
Collaborator Author

It seems this issue now belongs in OSCAL-Pages given the user story and AC requirements, moving there now (it'll stay on the board here and in sprint as well).

@aj-stein-nist aj-stein-nist transferred this issue from usnistgov/OSCAL Sep 19, 2023
@aj-stein-nist
Copy link
Collaborator Author

We have merged the draft of the first blog post, but need to decide when to release it under which release type given guidance in the repo, so I presume we can discuss during standup.

@aj-stein-nist
Copy link
Collaborator Author

aj-stein-nist commented Sep 20, 2023

From discussion with the team, I misread the guidance on content releases versus code changes in the guidance alluded to in #43 (comment). Will push to main shortly and then close this.

@aj-stein-nist
Copy link
Collaborator Author

This update has been deployed with the successful completion of this GHA workflow job run.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants