Skip to content

feat: Initial workspaces page route + skeleton - #220

Merged
bryphe-coder merged 14 commits into
mainfrom
bryphe/feat/workspaces-page-skeleton
Feb 16, 2022
Merged

bryphe-coder merged 14 commits into
mainfrom
bryphe/feat/workspaces-page-skeleton

Conversation

@bryphe-coder

Copy link
Copy Markdown
Contributor

This implements an initial route for the workspaces page at /workspaces/{user}/{workspace}, and an additional storybook entry:

image

Just the header is rendering right now. Will be adding the additional sections prototyped in #219 in subsequent PRs

Related to #67

@bryphe-coder bryphe-coder self-assigned this Feb 9, 2022
@codecov

codecov Bot commented Feb 9, 2022 •

Copy link
Copy Markdown

Codecov Report

Merging #220 (35318a4) into main (6009c90) will decrease coverage by 0.30%.
The diff coverage is 42.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #220      +/-   ##
==========================================
- Coverage   67.98%   67.67%   -0.31%     
==========================================
  Files         132      135       +3     
  Lines        7099     7149      +50     
  Branches       70       73       +3     
==========================================
+ Hits         4826     4838      +12     
- Misses       1783     1820      +37     
- Partials      490      491       +1     
Flag Coverage Δ
unittest-go-macos-latest 65.96% <ø> (-0.21%) ⬇️
unittest-go-ubuntu-latest 67.09% <ø> (-0.29%) ⬇️
unittest-go-windows-latest 65.98% <ø> (+0.13%) ⬆️
unittest-js 64.61% <42.00%> (-1.62%) ⬇️
Impacted Files Coverage Δ
site/components/Workspace/index.ts 0.00% <0.00%> (ø)
site/pages/workspaces/[user]/[workspace].tsx 0.00% <0.00%> (ø)
site/components/Workspace/Workspace.tsx 100.00% <100.00%> (ø)
peerbroker/dial.go 76.19% <0.00%> (-4.77%) ⬇️
peer/conn.go 77.17% <0.00%> (-2.06%) ⬇️
coderd/provisionerdaemons.go 57.84% <0.00%> (+0.61%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6009c90...35318a4. Read the comment docs.

@kylecarbs kylecarbs 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!

@bryphe-coder

Copy link
Copy Markdown
Contributor Author

Thanks for reviewing @kylecarbs 🙏

@bryphe-coder
bryphe-coder merged commit 4954a6b into main Feb 16, 2022
@bryphe-coder
bryphe-coder deleted the bryphe/feat/workspaces-page-skeleton branch February 16, 2022 04:49
nickvigilante added a commit that referenced this pull request Oct 21, 2026
#30873)

## Summary

An axe sweep of every page on https://coder.com/beta-docs
(coder/docs-engine#224) found two content-side problems. Nine
screenshots have alt text identical to the italic caption right after
them, so screen readers read the same words twice (axe
`image-redundant-alt`). Four hand-written tables have an empty top-left
header cell, which leaves their row-label column without a name (axe
`empty-table-header`). This fixes both. These are content fixes on
`main` only; earlier release lines keep the old text.

## Findings

| Rule | Pages | Cause | Fixed where |
| --- | --- | --- | --- |
| image-redundant-alt | 4 | Alt text repeats the caption | This PR |
| empty-table-header | 4 hand-written | Empty corner header cell | This
PR |
| empty-table-header | 105 CLI reference pages, `audit-logs.md` |
Generated tables with empty headers | Not here: needs a generator change
|
| empty-table-header | `admin/networking/port-forwarding.md` | Spanning
corner cells in a raw HTML matrix | Not here: needs a rework of that
table |
| heading-order | `remote-desktops.md` | `<div class="tab">` typo |
Separate PR |
| link-name, scrollable-region-focusable, aria-valid-attr-value, label |
many | Engine | coder/docs-engine #220, #217, #224 |

## Fix

Each of the nine screenshots gets alt text that describes what it shows
(for example, "Preset dropdown with Ruby Development added between Full
Stack and Web Development"), and keeps its caption. The corner cells
become "Permission" (Groups and roles), "Component" (air-gapped
comparison), "Scenario" (scale-testing workloads) and "Input" (workspace
tags). Tables were re-padded with `markdown-table-formatter`.

## QA

1. Open each production page below. Expected: the screenshots and tables
look the same as before, except the four tables now show a word in their
top-left header cell.
2. In Chrome DevTools (Elements) or Firefox's Inspector, select a
screenshot on the Add a language page. Expected: its `alt` differs from
the italic caption under it.

## Pages to compare

| What to check | Production | Preview |
| --- | --- | --- |
| Screenshot alt text vs caption |
https://coder.com/beta-docs/@main/get-started/customize-your-template/add-a-language/
| This PR's GitHub preview:
https://github.com/coder/coder/blob/vigilante/docs-a11y-fixes/docs/get-started/customize-your-template/add-a-language.md
|
| Roles table corner cell |
https://coder.com/beta-docs/@main/admin/users/groups-roles/ |
https://github.com/coder/coder/blob/vigilante/docs-a11y-fixes/docs/admin/users/groups-roles.md
|
| Scale-testing table corner cell |
https://coder.com/beta-docs/@main/install/validate/scale-testing/ |
https://github.com/coder/coder/blob/vigilante/docs-a11y-fixes/docs/install/validate/scale-testing.md
|

## Testing

`markdownlint-cli2` and `markdown-table-formatter` over the eight
changed files: 0 errors. Re-running the sweep after merge should drop
`image-redundant-alt` and the four tables' `empty-table-header` findings
from `@main`.

## Upstream

No: these are Coder content fixes, not Fumadocs bugs.

Linear: [DOCS-1303](https://linear.app/coder/issue/DOCS-1303)

---

🤖 Built with AI assistance.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants