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

[SIMPLE-FORMS] doc: update form_submission_pdf_backups.md #19436

Merged
merged 2 commits into from
Nov 18, 2024

Conversation

pennja
Copy link
Contributor

@pennja pennja commented Nov 13, 2024

Summary

  • This work is behind a feature toggle (flipper): NO
  • This PR provides minor changes to the PDF backup documentation which clarify and streamline some of the information.
  • I work for the Veteran Facing Forms team, which owns the maintenance of these documents.
  • Since this work is not behind a feature toggle, there are no specific success criteria related to a flipper.

Related issue(s)

Testing done

  • To verify the changes, reviewers should:
    1. Ensure that the PDF download instructions are clearly separated and easy to follow.
    2. Confirm that the documentation is accessible and correctly formatted.

What areas of the site does it impact?

  • This change impacts the documentation section of the Platform, specifically the areas related to PDF downloads and form remediation. The code touched only involves documentation files, so no other areas of the site are directly affected.

Acceptance criteria

  • Clear, step-by-step instructions for PDF download implementation are available and easy to locate.
  • Documentation is moved to the official Platform documentation repository.
  • No error nor warning in the console.
  • Documentation has been updated.
  • No sensitive information (i.e. PII/credentials/internal URLs/etc.) is captured in logging, hardcoded, or specs.

Requested Feedback

I would appreciate feedback on the clarity and organization of the new documentation structure. Are the PDF download instructions easy to follow? Is there anything else that could be improved to enhance user understanding? Thank you!

Sorry, something went wrong.

@pennja pennja requested review from a team as code owners November 13, 2024 13:46
@va-vfs-bot va-vfs-bot temporarily deployed to jap/simple-forms/1840-minor-documentation-tweaks-01/main/main November 13, 2024 13:55 Inactive
ndsprinkle
ndsprinkle previously approved these changes Nov 13, 2024
Copy link
Contributor

@Thrillberg Thrillberg left a comment

Choose a reason for hiding this comment

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

Looks great!

Verified

This commit was signed with the committer’s verified signature.
arielshaqed Ariel Shaqed (Scolnicov)

Verified

This commit was signed with the committer’s verified signature.
arielshaqed Ariel Shaqed (Scolnicov)
Copy link

Backend-review-group approval confirmed.

@pennja pennja merged commit b857031 into master Nov 18, 2024
26 checks passed
@pennja pennja deleted the jap/simple-forms/1840-minor-documentation-tweaks-01 branch November 18, 2024 22:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants