Simpler.Grants.gov Public Wiki
Grants.govSimpler.Grants.govGitHubDiscourse
  • 👋Welcome
  • GET INVOLVED
    • Why open source?
    • How to contribute code
    • How to file issues
      • Report a bug
      • Request a feature
      • Report a security vulnerability
    • Community guidelines
      • Code of Conduct
      • Reporting and removing content
      • Incident response protocol
    • Community events
      • Fall 2024 Coding Challenge
        • Event Submissions & Winners
      • Spring 2025 Collaborative Coding Challenge
        • Event Submissions & Winners
    • Communication channels
  • Product
    • Roadmap
    • Deliverables
      • 🏁Static site soft launch
      • 🏁Static site public launch
      • 🏁GET Opportunities
      • 🏁Open source onboarding
      • 🏁Co-Design Group planning
    • Decisions
      • ADR Template
      • ADRs
        • Dedicated Forum for Simpler.Grants.gov Community
        • Recording Architecture Decisions
        • Task Runner for the CI / CD Pipeline
        • API Language
        • Use Figma for design prototyping
        • ADR: Chat
        • DB Choices
        • API Framework and Libraries
        • Back-end Code Quality Tools
        • Front-end Language
        • Communications Tooling: Wiki Platform
        • Use Mural for design diagrams and whiteboarding
        • Ticket Tracking
        • Front-end Framework
        • Front-end Code Quality Tools
        • Front-end Testing & Coverage
        • Backend API Type
        • Front-end Testing & Coverage
        • Deployment Strategy
        • Use U.S. Web Design System for components and utility classes
        • FE server rendering
        • Use NPM over Yarn Architectural Decision Records
        • U.S. Web Design System in React
        • Communications Tooling: Video Conferencing
        • Back-end Production Server
        • Communications Tooling: Analytics Platform
        • Commit and Branch Conventions and Release Workflow
        • Cloud Platform to Host the Project
        • Infrastructure as Code Tool
        • Data Replication Strategy & Tool
        • HHS Communications Site
        • Communications Tooling: Email Marketing
        • Communications Tooling: Listserv
        • Use Ethnio for design research
        • Uptime Monitoring
        • Database Migrations
        • 30k ft deliverable reporting strategy
        • Public measurement dashboard architecture
        • Method and technology for "Contact Us" CTA
        • E2E / Integration Testing Framework
        • Logging and Monitoring Platform
        • Dashboard Data Storage
        • Dashboard Data Tool
        • Search Engine
        • Document Storage
        • Document Sharing
        • Internal Wiki ADR
        • Shared Team Calendar Platform
        • Cross-Program Team Health Survey Tool
        • Adding Slack Users to SimplerGrants Slack Workspace
        • Repo organization
        • Internal knowledge management
        • Migrate Existing API Consumers
      • Infra
        • Use markdown architectural decision records
        • CI/CD interface
        • Use custom implementation of GitHub OIDC
        • Manage ECR in prod account module
        • Separate terraform backend configs into separate config files
        • Database module design
        • Provision database users with serverless function
        • Database migration architecture
        • Consolidate infra config from tfvars files into config module
        • Environment use cases
        • Production networking long term state
    • Analytics
      • Open source community metrics
      • API metrics
  • DESIGN & RESEARCH
    • Brand guidelines
      • Logo
      • Colors
      • Grid and composition
      • Typography
      • Iconography
      • Photos and illustrations
    • Content guidelines
      • Voice and tone
    • User research
      • Grants.gov archetypes
  • REFERENCES
    • Glossary
  • How to edit the wiki
Powered by GitBook
On this page
  • Change requests
  • Git commit history
  • Change logs
  • How to use GitBook to make edits

Was this helpful?

Edit on GitHub

How to edit the wiki

The Simpler.Grants.gov public wiki is a collaborative resource. Any internal team member may submit a change request (CR) to update or add content to the wiki. We created a protocol everyone should follow to ensure the wiki aligns with our needs and quality standards.

Change requests

  • Before merging changes, you must request a review from at least one content owner. GitBook will email you when the content owner has approved the CR. At that point, you can merge the changes. Use the following table to identify the correct content owner to tag in your request:

Type of content
Content owners / CR approvers
Content owners by name

Welcome page

Nava Content Strategist

Michelle M.

Get involved section

Nava Open Source Evangelist Nava Content Strategist

Brandon T. Michelle M.

Product section

Nava Product Manager

Max K. Chris W. Eric S. (SimplerFind) Chris K. (SimplerApply)

Design & Research section

Nava Design Lead Nava Content Strategist

Andy C. Michelle M.

References section

Nava Content Strategist

Michelle M.

  • Content owners do not need to request a review for their section.

  • A6 manages the GitBook and can update any content. Feel free to add them as additional reviewers, especially if you need a fast response or the primary content owner is out of office.

  • Structural changes, such as requests to add or delete pages or sections, always require CR approval from the Nava Content Strategist.

  • The Nava Content Strategist can help individuals with wiki and editing consultations.

  • Suggestion: When requesting feedback on a change request, it can be helpful to send the reviewer a Slack message with the following information:

    • A link to (1) the change request and (2) the preview of published docs

    • A summary of the changes

    • A list of people you’re requesting feedback from

Git commit history

  • Naming convention:

    • [GitHub issue #]: Short description

      • Example: #1234: Altered format of images in brand guidelines

    • Omit the GitHub issue number if none is associated with your changes.

      • Example: Altered format of images in brand guidelines

Change logs

Change logs have historically existed on each wiki page. However, as of March 2025, we don't have strict guidelines for using the logs.

  • Existing change logs will stay, and anyone can add change logs to pages that don’t have one.

  • Any contributor may add entries to the logs if desired.

  • Tip: Log significant changes (such as updating out-of-date, stale content, or deleting large sections) but not minor changes (such as improvements to spelling, formatting, or clarity). Generally speaking, significant changes provide helpful context to the reader.

How to use GitBook to make edits

  1. In the top left corner, it should say Simpler Grants. If not, you're in the wrong workspace—click it to switch to the correct workspace. If you don't see the option, ask Michelle M. or anyone from A6 to give you 'reviewer' permissions.

  2. Go to Public Wiki , under the Spaces section of the left nav.

  3. Click Edit .

  4. Make your changes.

  5. Name the change using the instructions in "Git commit history" above.

  6. Click the arrow next to Merge to open the option to Request a review .

  7. Add reviewers using the "content owners" table above.

  8. When you receive an email that your change was reviewed, use the Merge button to publish your changes.

PreviousGlossary

Last updated 8 days ago

Was this helpful?

Our official method and source of truth for tracking changes is GitBook’s . This process automatically captures the person’s name, the changes, and the date/time of the change. GitBook will generate a default title for the CR as [Name’s] [Date] changes. You need to re-title it to match our naming convention.

Log in to GitBook:

commit history
https://app.gitbook.com/
Rename your change request in the top left of the header
Header of the wiki's editor with an arrow pointing to the field where the CR should be re-titled