Skip to content

Docs: improvements for manual testing - #3604

Merged
thekaveman merged 32 commits into
mainfrom
docs/manual-testing
Mar 23, 2026
Merged

Docs: improvements for manual testing#3604
thekaveman merged 32 commits into
mainfrom
docs/manual-testing

Conversation

@thekaveman

@thekaveman thekaveman commented Mar 17, 2026

Copy link
Copy Markdown
Member

Closes #3600

What this PR does

Review

  1. Checkout the branch locally
  2. Ensure the docs site builds without error
  3. Navigate through the local pages, confirm all links work etc.
  4. Attempt to hit the previous all-in-one page at /guides/manual-tests/ and be redirected to the new Getting started page

@github-actions github-actions Bot added the documentation [auto] Improvements or additions to documentation label Mar 17, 2026
@thekaveman
thekaveman force-pushed the docs/manual-testing branch from 420a5d4 to 7cc7e3a Compare March 17, 2026 22:09
@github-actions

github-actions Bot commented Mar 17, 2026

Copy link
Copy Markdown
Contributor

Coverage report

This PR does not seem to contain any modification to coverable code.

@github-actions

Copy link
Copy Markdown
Contributor

@thekaveman
thekaveman force-pushed the docs/manual-testing branch 8 times, most recently from 33bf8f5 to 10ef398 Compare March 18, 2026 23:33
@thekaveman
thekaveman marked this pull request as ready for review March 18, 2026 23:34
@thekaveman
thekaveman requested a review from a team as a code owner March 18, 2026 23:34
@Scotchester
Scotchester self-requested a review March 19, 2026 19:29

@Scotchester Scotchester left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Outstanding work! This will be a huge upgrade to our testing docs.

A few more things I'd like to see added eventually (not asking for them in this PR, just a note to selves):

  • Testing SSO
  • Testing analytics
  • Screen reader testing
  • QA testing an RC on test (What's generally considered "enough"?)

Comment thread docs/tutorials/logingov-sandbox.md Outdated
Comment thread docs/tutorials/logingov-sandbox.md Outdated
Comment thread docs/guides/manual-testing/keyboard.md Outdated
Comment thread docs/guides/manual-testing/keyboard.md Outdated
Comment thread docs/guides/manual-testing/keyboard.md Outdated
Comment thread docs/guides/manual-testing/in-person.md Outdated
Comment thread docs/guides/manual-testing/smoke-testing.md Outdated
Comment thread docs/guides/manual-testing/smoke-testing.md
Comment thread docs/guides/manual-testing/smoke-testing.md Outdated
Comment thread docs/guides/manual-testing/smoke-testing.md
@thekaveman

thekaveman commented Mar 19, 2026

Copy link
Copy Markdown
Member Author

Thanks for the review and suggestions @Scotchester!!

Regarding:

QA testing an RC on test (What's generally considered "enough"?)

I was hoping the table at the bottom here covered that but let me know if you have ideas for how to improve: https://benefits-3604--cal-itp-previews.netlify.app/guides/manual-testing/getting-started/#when-to-test

Comment thread docs/guides/manual-testing/self-service.md Outdated
@Scotchester

Copy link
Copy Markdown
Member

Regarding:

QA testing an RC on test (What's generally considered "enough"?)

I was hoping the table at the bottom here covered that but let me know if you have ideas for how to improve: https://benefits-3604--cal-itp-previews.netlify.app/guides/manual-testing/getting-started/#when-to-test

Hmm, yeah, I suppose it does, but I'm now realizing I didn't connect a dot in my head to this idea when I posted it.

I was thinking about the actual release process and how we execute it, and one thing I thought would be useful to have a couple copyable chunks of Markdown for us to drop into the comments of the release issue, one for QA and one for smoke. The release manager can post it and then people can just check things off with lower risk of edit conflicts as we enter in new lines of what we're testing.

Smoke testing has its own page, so it makes sense for that one to go there, but QA testing doesn't have its own page, so the potential home for that one is less obvious.

@thekaveman

Copy link
Copy Markdown
Member Author

I thought would be useful to have a couple copyable chunks of Markdown for us to drop into the comments of the release issue

That would be super useful, you are correct! Lemme think on this and amend the PR. Going back to draft for now...

@thekaveman
thekaveman marked this pull request as draft March 19, 2026 22:28
thekaveman and others added 16 commits March 20, 2026 16:35
Co-authored-by: Scott Cranfill <scranfill@compiler.la>
Co-authored-by: Scott Cranfill <scranfill@compiler.la>
Co-authored-by: Scott Cranfill <scranfill@compiler.la>
Co-authored-by: Scott Cranfill <scranfill@compiler.la>
Co-authored-by: Scott Cranfill <scranfill@compiler.la>
Co-authored-by: Scott Cranfill <scranfill@compiler.la>
Co-authored-by: Scott Cranfill <scranfill@compiler.la>
Co-authored-by: Scott Cranfill <scranfill@compiler.la>
Co-authored-by: Scott Cranfill <scranfill@compiler.la>
Co-authored-by: Scott Cranfill <scranfill@compiler.la>
Co-authored-by: Scott Cranfill <scranfill@compiler.la>
Co-authored-by: Scott Cranfill <scranfill@compiler.la>
Co-authored-by: Scott Cranfill <scranfill@compiler.la>
@thekaveman
thekaveman force-pushed the docs/manual-testing branch from 2d638d4 to 041fe8e Compare March 20, 2026 16:35
scenarios as markdown snippet for release issue comment
@thekaveman
thekaveman force-pushed the docs/manual-testing branch from 041fe8e to bba6f07 Compare March 20, 2026 16:41
@thekaveman
thekaveman marked this pull request as ready for review March 20, 2026 16:41
@thekaveman
thekaveman requested a review from Scotchester March 20, 2026 16:41
@thekaveman

Copy link
Copy Markdown
Member Author

Combined the Self-service and In-person pages into a single QA Testing page.

Added markdown snippets of scenarios for QA and Smoke testing for easy copy/paste into the release issue.

lalver1
lalver1 previously approved these changes Mar 20, 2026

@lalver1 lalver1 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This looks great @thekaveman!! I was following along and I agree with @Scotchester's comments, they were all very helpful. I took one last pass at the final reorganization and it looks good, I like the markdown snippets for the release process issue 👍. I guess the only other thing is that I also tested following links throughout the docs and didn't come across any broken ones.

@angela-tran angela-tran left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks @thekaveman for bringing these docs up-to-date and also making them much more complete. The guidance on which testing applies when is especially helpful.

I left comments on just some minor things I noticed. This is looking like it'll be ready to merge soon!

Comment thread docs/guides/manual-testing/qa.md Outdated
Comment thread docs/guides/manual-testing/translations.md Outdated
Co-authored-by: Angela Tran <angela@compiler.la>
Co-authored-by: Scott Cranfill <scranfill@compiler.la>

@Scotchester Scotchester left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM! Great work here 👏

@thekaveman
thekaveman merged commit 9513139 into main Mar 23, 2026
13 checks passed
@thekaveman
thekaveman deleted the docs/manual-testing branch March 23, 2026 15:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation [auto] Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve documentation around manual testing

4 participants