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

Enforce draft status on new content and new revisions #1242

Merged
merged 3 commits into from
May 23, 2024

Conversation

greg-does-weather
Copy link
Collaborator

@greg-does-weather greg-does-weather commented May 22, 2024

What does this PR do? 🛠️

  • Enables the content moderation and workflow modules
  • Creates a single workflow called "Weather.gov content moderation workflow"
    • Adds three moderation states:
      • draft
      • published
      • archived
    • Adds three moderation transitions:
      • create new draft
        • initiated when new content is created
        • initiated when a new revision of existing content is created
      • publish
        • initiated when a content revision is published
      • archive
        • initiated when content is unpublished
        • being archived does NOT prevent the content from being published again, or new revisions from being created
  • Updates the form buttons according to the CMS workflows doc
  • Updates the content saving and unpublishing behavior so that it stays on the edit page

Content moderation and workflow are core modules, not 3rd-party, so I did not update the contributed modules documentation.

image

Copy link
Contributor

It looks like our enabled modules has changed in this PR. Please ensure any documentation in https://github.com/weather-gov/weather.gov/tree/main/docs/contributed-modules.md has been updated!

@greg-does-weather greg-does-weather force-pushed the mgwalker/greg-playing-with-content-moderation branch from 02d5375 to 652e41a Compare May 22, 2024 23:31
@greg-does-weather
Copy link
Collaborator Author

I've deployed this in my environment. @kmranjo If you want to pair up to look at it sometime, let me know! Also please ping me if you don't have the right access in my environment. 😬

Copy link
Collaborator

@eric-gade eric-gade left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Merge it!

Code Review Checklist

This is an automated comment on every pull request requiring a review. A checked item is either an assertion that I have tested this item or an indication that I have verified it does not apply to this pull request.

The Basics

  • Checks are passing
  • I read the code
  • I ran the code
  • (if applicable) Post deploy steps are run
  • (if applicable) I validated the change on the deployed version in

Documentation

  • changes to “how we do things” are documented in READMEs
  • all new functions and methods are commented using plain language
  • any new modules added documented in modules.md

Security

  • security false positives are documented
  • data from external sources is cleaned and clearly marked

Reliability

  • error handling exists for unusual or missing values
  • interactions with external systems are wrapped in try/except
  • functionality is tested with unit or integration tests
  • dependency updates in composer.json also got changed in composer-lock.json

Infrastructure

  • all changes are auditable and documented via a script
  • it is clear who can and should run the script
  • (if applicable) diagrams have been updated or added in PlantUML

Accessibility

  • New pages have been added to cypress-axe file so that they will be tested with our automated accessibility testing
  • Meets WCAG 2.0 AA or 2.1 AA for Section 508 compliance
    • Site is keyboard accessible. All interactions can be accessed with a keyboard
    • Site is free of keyboard traps. The keyboard focus is never trapped in a loop
    • All form inputs have explicit labels
    • Form instructions are associated with inputs
    • All relevant images use an img tag
    • All images have appropriate alt attributes
    • Multimedia is tagged. All multimedia has appropriate captioning and audio description
    • Text has sufficient color contrast. All text has a contrast ratio of 4.5:1 with the background
    • Site never loses focus. Focus is always visible when moving through the page with the keyboard
    • Tab order is logical
    • Tables are coded properly. Tables have proper headers and column attributes
    • Headings are nested properly. Heading elements are nested in a logical way
    • Language is set. The language for the page is set
    • CSS is not required to use the page. The page makes sense with or without CSS
    • Links are unique and contextual. All links can be understood taken alone, e.g., ‘Read more - about 508’
    • Page titles are descriptive

Device Matrix

  • firefox/gecko (renders correctly and user interactions work)
  • chrome/chromium/edge (renders correctly and user interactions work)
  • safari/webkit (renders correctly and user interactions work)
  • web page is readable and usable
    • at 480px (mobile)
    • at 640px (tablet)
    • at 1024px (desktop)

@greg-does-weather greg-does-weather merged commit 1242af8 into main May 23, 2024
13 checks passed
@greg-does-weather greg-does-weather deleted the mgwalker/greg-playing-with-content-moderation branch May 23, 2024 23:43
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.

3 participants