Update and restructure QA local setup guide - #769
Merged
nora-weisser merged 2 commits intoAug 16, 2026
Conversation
|
ptrcja
marked this pull request as ready for review
August 6, 2026 08:45
ptrcja
requested review from
Sowmiya07,
Tooonia,
dricazenck,
goelsonali,
lauracabtay and
nverbic
August 6, 2026 08:45
nora-weisser
merged commit Aug 16, 2026
abae4d3
into
Women-Coding-Community:main
5 of 6 checks passed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.



Description
Following
docs/qa_local_setup.mdfor the first time as a new contributor, I ran into several steps that didn't behave as documented. @nora-weisser and I agreed it was worth improving while the problems were fresh, so I worked through the whole guide against a running stack and updated everything that didn't match. I went through it twice, the secondtime starting from a completely empty database.
The aim is that someone setting up the backend for the first time can follow it start to
finish without getting stuck, and knows what to do when something looks broken but isn't.
There are two kinds of change here: fixes, all reproduced locally, and a restructure,
which is more of a suggestion than a conclusion.
Corrected
Three things the guide described, which don't work that way:
mentor@wcc.dev, then callGET /api/platform/v1/mentors401without an API key, then403 Role denied, because mentors can't call that endpoint. Now usesadmin@wcc.devand sends both headers.Reset seeded user credentialsinstead — which reads like a warning but means the seed worked.enabled: trueNewly documented
Three things that weren't covered, and each cost me time:
GET /api/cms/v1/mentorship/mentorsreturns200with an empty mentor list until aMENTORSpage exists — the static fallback never fills mentors in. This looks exactly likea broken seed. Now explained, with the fix.
409if the page already exists(which it will, on any database that's been used before).
apiKeyandbearerAuth, and neither ispre-filled — so it's easy to authorize and still get
401.Restructure
Two changes to how the guide is organised, both open to discussion:
Swagger UI is now the main path, with curl kept as reference. The guide used curl
throughout. Given the audience is QA, Swagger seemed a better default — nothing to escape,
requests visible on screen, credentials entered once. Every curl example is still there,
under Reference.
Reference material grouped after the walkthrough. The steps now run start to finish
without interruption, and auth rules, seeding internals, seed config and troubleshooting sit
together below a divider.
Both are layout changes only, so they're easy to adjust if a different arrangement works
better.
Also included
admin-wcc-app/README.md— the admin portal had no README, and the guide now links toit. It documents the
NEXT_PUBLIC_API_KEYtrap:.env.exampleships it empty, and becausethe login endpoint doesn't need it, login succeeds and then every screen returns 401.
warning, which is harmless.
out to the portal's own README so each document covers its own area.
Notes
A few things came up that are worth fixing separately, rather than in this PR:
section of this guide.
admin-wcc-app/.env.examplecould default toNEXT_PUBLIC_API_KEY=local.Happy to split this up if it's easier to review in pieces.
Related Issue
Related but not closed by this PR: #654, which is the reason the "Making the mentor list work" section needs to exist at all.
Change Type
Pull request checklist
Please check if your PR fulfills the following requirements: