[Docs] Illustrate Kanvas Designer with api-platform-aws walkthrough (#977)#990
[Docs] Illustrate Kanvas Designer with api-platform-aws walkthrough (#977)#990leecalcote merged 2 commits intomasterfrom
Conversation
leecalcote
added
help wanted
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a design specification and an implementation plan to establish a continuous narrative featuring the mascot "Five" for the Layer5 Cloud documentation, alongside updates to the Kanvas Designer content. Review feedback identifies a consistency error regarding design ownership and recommends using relative paths instead of absolute ones in the implementation plan to improve portability.
| ## Building the `api-platform-aws` Design | ||
|
|
||
| Remember to focus on what the user needs to know, not just what you think is interesting about your project! If they don’t need to understand your original design decisions to use or contribute to the project, don’t put them in, or include your design docs in your repo and link to them. Similarly, most users will probably need to know more about how features work when in use rather than how they are implemented. Consider a separate architecture page for more detailed implementation and system design information that potential project contributors can consult. --> | ||
| Jordan Reyes opens Kanvas Designer and creates a new design named `api-platform-aws` inside the `orbital-production` workspace. The blank canvas is the starting point; from here the entire AWS-backed API platform will take shape. |
There was a problem hiding this comment.
There is a discrepancy between this narrative and the canonical seed inventory defined in the design spec and implementation plan. Here, Jordan Reyes is described as the creator of the api-platform-aws design, but the spec (line 124) and plan (line 390) list Five as the owner. Please ensure consistency across the narrative documentation.
| - [ ] **Step 1: Create the target directory** | ||
|
|
||
| ```bash | ||
| mkdir -p /Users/l/code/docs/static/images/five |
There was a problem hiding this comment.
The implementation plan contains hardcoded absolute paths (e.g., /Users/l/code/docs/). These paths are specific to a single user's environment and will cause the plan to fail for other developers or automated agents. Please use relative paths or environment variables to ensure portability.
| mkdir -p /Users/l/code/docs/static/images/five | |
| mkdir -p static/images/five |
| cp /Users/l/code/layer5/src/assets/images/five/SVG/team-of-fives.svg \ | ||
| /Users/l/code/docs/static/images/five/ | ||
|
|
||
| cp /Users/l/code/layer5/src/assets/images/five/SVG/layer5-five-mascot-means-business.svg \ | ||
| /Users/l/code/docs/static/images/five/ | ||
|
|
||
| cp /Users/l/code/layer5/src/assets/images/five/SVG/layer5-five-mascot-means-business.gif \ | ||
| /Users/l/code/docs/static/images/five/ | ||
|
|
||
| cp /Users/l/code/layer5/src/assets/images/five/SVG/resources-sign.svg \ | ||
| /Users/l/code/docs/static/images/five/ | ||
|
|
||
| cp /Users/l/code/layer5/src/assets/images/five/SVG/stick-figures.svg \ | ||
| /Users/l/code/docs/static/images/five/ | ||
|
|
||
| for i in $(seq 1 19); do | ||
| cp /Users/l/code/layer5/src/assets/images/five/SVG/${i}.svg \ | ||
| /Users/l/code/docs/static/images/five/ | ||
| done |
There was a problem hiding this comment.
These copy commands rely on absolute paths specific to a local machine. Consider using relative paths (e.g., ../layer5/...) or a variable for the source repository path to ensure the plan can be executed in different environments.
| - [ ] **Step 4: Commit** | ||
|
|
||
| ```bash | ||
| cd /Users/l/code/docs |
There was a problem hiding this comment.
This cd command uses an absolute path. It is recommended to use relative paths or remove redundant navigation if the execution context is already at the repository root. This issue recurs throughout the file (e.g., lines 119, 154, 209, etc.).
| - [ ] **Step 4: Commit** | ||
|
|
||
| ```bash | ||
| cd /Users/l/code/docs |
There was a problem hiding this comment.
| cd /Users/l/code/docs | |
| cd docs |
There was a problem hiding this comment.
Applied in 527c5fa — replaced all occurrences of the hardcoded cd /Users/l/code/docs path with the generic cd docs throughout the plan file.
leecalcote
force-pushed
the
feat/narrative-977-kanvas-designer
branch
from
527c5fa to
4057952
Compare
…977) Signed-off-by: Lee Calcote <lee.calcote@layer5.io>
…rchitects it Signed-off-by: Lee Calcote <lee.calcote@layer5.io>
leecalcote
force-pushed
the
feat/narrative-977-kanvas-designer
branch
from
4057952 to
5901850
Compare
Summary
{{% pageinfo %}}block and stale Lorem-ipsum HTML comment incontent/en/kanvas/designer/_index.mdwith a substantive intro and narrative walkthrough.api-platform-awsDesign") follows Jordan Reyes and Rex Park through: creating the design in theorbital-productionworkspace, dragging in EKS, API Gateway, Lambda, RDS, and S3 components, wiring the API Gateway → Lambda → EKS → RDS/S3 data flow, annotating the RDS connection with a team-facing comment, sharing with Rex for review, Rex raising an ALB question as an in-canvas comment, and Jordan revising the connection collaboratively./cloud/aboutfor readers who want to meet the full Orbital Labs cast.Closes #977. Depends on #979 for the
/cloud/aboutlink target.Test plan
hugo --quietexits 0) ✅/kanvas/designer/in localhugo serve{{% pageinfo %}}block is fully replaced — no leftover placeholder textweight: 4,aliases: [/meshmap/designer/],categories: [Designer]/cloud/about