[Docs] Update sharing-a-workspace, add promoting-a-design tutorial, and add kanvas/getting-started narrative callout#988
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 establishes a continuous narrative across the Layer5 Cloud and Kanvas documentation, introducing a cast of fictional characters and organizations to provide context for tutorials and guides. The changes include a comprehensive design specification, a detailed implementation plan, and updates to existing content to integrate these narrative elements. Review feedback highlights the need for consistent capitalization of UI labels and terminology, proper punctuation in lists, the removal of hardcoded absolute paths in implementation scripts, and alignment of asset filenames between the design spec and the implementation plan.
| 1. Click the design you want to share (`microservices-baseline` in Five's case). | ||
| 2. Click **Share**. | ||
| 3. Enter Rex's email address (`rex@orbital-labs.example`). | ||
| 4. Set the permission level — Five gives Rex **edit** access so he can deploy and modify the design. |
There was a problem hiding this comment.
The permission level "edit" should be capitalized as "Edit" to maintain consistency with other UI labels mentioned in the document (e.g., Share, Send, No access, Remove).
| 4. Set the permission level — Five gives Rex **edit** access so he can deploy and modify the design. | |
| 4. Set the permission level — Five gives Rex **Edit** access so he can deploy and modify the design. |
| 1. Open the design and click **Share** | ||
| 2. Find Rex in the list of people with access | ||
| 3. Change Rex's permission to **No access** or click **Remove** |
There was a problem hiding this comment.
These list items are missing trailing periods, which is inconsistent with the step-by-step instructions provided earlier in the document (lines 16-20).
| 1. Open the design and click **Share** | |
| 2. Find Rex in the list of people with access | |
| 3. Change Rex's permission to **No access** or click **Remove** | |
| 1. Open the design and click **Share**. | |
| 2. Find Rex in the list of people with access. | |
| 3. Change Rex's permission to **No access** or click **Remove**. |
| ### External Links | ||
|
|
||
| Stumptown PBR&B keytar plaid street art, forage XOXO pitchfork selvage affogato green juice listicle pickled everyday carry hashtag. Organic sustainable letterpress sartorial scenester intelligentsia swag bushwick. Put a bird on it stumptown neutra locavore. IPhone typewriter messenger bag narwhal. Ennui cold-pressed seitan flannel keytar, single-origin coffee adaptogen occupy yuccie williamsburg chillwave shoreditch forage waistcoat. | ||
| - The design is shared with someone who doesn't have a Layer5 account or isn't signed in. |
There was a problem hiding this comment.
Consider capitalizing "Account" to maintain consistency with existing terminology used in other parts of the documentation (e.g., "Layer5 Account").
| - The design is shared with someone who doesn't have a Layer5 account or isn't signed in. | |
| - The design is shared with someone who doesn't have a Layer5 Account or isn't signed in. |
| - [ ] **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). This makes the plan non-portable and will cause failures for other contributors. Please use relative paths or environment variables.
| mkdir -p /Users/l/code/docs/static/images/five | |
| mkdir -p static/images/five |
| | `cloud/identity/users` | Five, Maya | Five's profile card; Maya as Org Admin | SVG 1 (meet Five) | Low | Open | | ||
| | `cloud/identity/organizations` | Maya, Marcus | Orbital Labs org creation; Stellar Dynamics as enterprise tenant | — | Low | Open | | ||
| | `cloud/identity/teams` | Zara, Rex, Jordan | Infrastructure vs. Dev team setup | team-of-fives.svg | Low | Open | | ||
| | `cloud/security/roles` | Dr. Aiko, Zara | Provider Admin → Org Admin → Team Admin chain | business-mode.svg | Medium | Open | |
There was a problem hiding this comment.
The filename business-mode.svg is inconsistent with the filename layer5-five-mascot-means-business.svg used in the implementation plan. Please ensure the spec reflects the actual asset names.
| | `cloud/security/roles` | Dr. Aiko, Zara | Provider Admin → Org Admin → Team Admin chain | business-mode.svg | Medium | Open | | |
| | `cloud/security/roles` | Dr. Aiko, Zara | Provider Admin → Org Admin → Team Admin chain | `layer5-five-mascot-means-business.svg` | Medium | Open | |
|
leecalcote
force-pushed
the
feat/narrative-976-kanvas-gs
branch
from
49e0fb2 to
86ff367
Compare
leecalcote
changed the title
1 participant
Summary
content/en/cloud/tutorials/sharing-a-workspace.mdwith the Five + Rex / orbital-dev / microservices-baseline narrative (closes [Docs] Update cloud/tutorials/sharing-a-workspace with Five and Rex scenario #974)content/en/cloud/tutorials/promoting-a-design.mdtutorial — Five promotesprod-deployment-v2from orbital-staging to orbital-production, Zara approves (closes [Docs] Add tutorial: Promoting a design from staging to prod #975)content/en/kanvas/getting-started/_index.md(closes [Docs] Update kanvas/getting-started to reference narrative characters #976)Depends on #979 (now merged) for the
/cloud/aboutlink target.