reorganize and update showcase bundles - #204
Conversation
Signed-off-by: Emiliano Suñé <2395873+esune@users.noreply.github.com>
Signed-off-by: Emiliano Suñé <2395873+esune@users.noreply.github.com>
Signed-off-by: Emiliano Suñé <2395873+esune@users.noreply.github.com>
Signed-off-by: Emiliano Suñé <2395873+esune@users.noreply.github.com>
Signed-off-by: Emiliano Suñé <2395873+esune@users.noreply.github.com>
Signed-off-by: Emiliano Suñé <2395873+esune@users.noreply.github.com>
- Add scripts folder to PATH via remoteEnv in devcontainer.json - Scripts can now be called directly without relative path prefixes - Update OCABundleCreatePR.md with DevContainer examples - Both genBundle.sh and gen_ocabundlesjson.sh can be called by name when using DevContainer Signed-off-by: Emiliano Suñé <2395873+esune@users.noreply.github.com>
Signed-off-by: Emiliano Suñé <2395873+esune@users.noreply.github.com>
Signed-off-by: Emiliano Suñé <2395873+esune@users.noreply.github.com>
Signed-off-by: Emiliano Suñé <2395873+esune@users.noreply.github.com>
…indexes Signed-off-by: Emiliano Suñé <2395873+esune@users.noreply.github.com>
krobinsonca
left a comment
There was a problem hiding this comment.
Review
Thanks for tackling the showcase reorganization. The goals make sense (group showcase bundles, normalize the watermark, update to current credential identifiers). I have a few concerns that should be addressed before merge.
1. Inconsistent naming convention
The PR introduces two different conventions in one go:
bcgov-digital-trust/business-card-nonprod/— uses a-nonprodsuffixbcgov-digital-trust/showcase/member-card/,showcase/person/,showcase/student-card/— uses a parentshowcase/folder
The PR title says "live under a showcase folder" so the -nonprod rename looks out of place. Please pick one convention and apply it consistently. Either:
- All four under
showcase/(matches the title):showcase/business-card/,showcase/member-card/,showcase/person/,showcase/student-card/ - All use a suffix (matches the existing
LCRB/*-showcasepattern):business-card-showcase/,member-card-showcase/,person-showcase/,student-card-showcase/
2. Duplicate mkdocs.yml nav block
mkdocs.yml now has two - OCA Bundles: blocks — the original at line 92 stays, and a new one is appended at the end with an expanded list. This will render duplicate nav entries on the GitHub Pages site. Looks like a copy-paste from hand-editing the file.
Please remove the duplicate block at the end. The original block at line 92 (with updated paths) is sufficient.
Note: gen_ocabundlesjson.sh regenerates the nav from the folder structure on every merge, so any manual edits to mkdocs.yml get clobbered. That said, the static file is what gets committed, so it needs to be right.
3. Stale identifier removals from person-showcase
The new showcase/person/README.md drops these identifiers:
KCxVC8GkKywjhWJnUfCmkW:3:CL:20:PersonQA(candy:test)7xjfawcnyTUcduWVysLww5:3:CL:28075:PersonSIT(candy:dev)XpgeQa93eZvGSZBZef3PHn:3:CL:28075:PersonDEV(candy:dev)
If these cred defs are still in circulation in the showcase environment, dropping them will cause credentials to fall back to default rendering. Please confirm this is intentional.
4. Cross-folder image reference (minor)
showcase/person/OCABundle.json (and branding.json) still references bcgov-digital-trust/person/bc-logo.jpg — a different bundle. We flagged this same kind of cross-bundle image reference in PR #194. For consistency with that fix, please copy bc-logo.jpg into showcase/person/ and update the path locally.
Once #1 and #2 are addressed, this is good to go. The watermark normalization, devcontainer change, and updated docs are all welcome improvements.
Sign-off: Kyle Robinson (krobinsonca)
|
@krobinsonca will address 2 and 4. |
Signed-off-by: Emiliano Suñé <2395873+esune@users.noreply.github.com>
Signed-off-by: Emiliano Suñé <2395873+esune@users.noreply.github.com>
Signed-off-by: Emiliano Suñé <2395873+esune@users.noreply.github.com>
This PR reorganizes the OCA bundles related to credentials issued by the showcase application to live under a
showcasefolder, so that they are easily identifiable.It also updates the bundles to use
SHOWCASEas watermark and match the latest credential schemas/credential definitions created by the builder at the time of writing.