Skip to content

docs: console first-steps, docs CI, and image hygiene - #107

Merged
overtrue merged 1 commit into
mainfrom
overtrue/docs-ci-images
Jul 16, 2026
Merged

docs: console first-steps, docs CI, and image hygiene#107
overtrue merged 1 commit into
mainfrom
overtrue/docs-ci-images

Conversation

@overtrue

@overtrue overtrue commented Jul 15, 2026

Copy link
Copy Markdown
Collaborator

Summary (review workstreams: onboarding leftovers + docs CI & images — rustfs/backlog#1270, #1276) ⚠️ stacked on #99, merge after it

  • Console: First Steps (new page): sign in on :9001 → UI tour → first bucket → first upload → create access keys, reusing existing verified screenshots (every image path checked)
  • Windows/macOS install pages get concrete download links (GitHub Releases / rustfs.com)
  • Glossary: SNSD/SNMD/MNMD entries added; meaningless "No." column dropped; duplicate "Storage Gateway" entry merged
  • Docs CI: scripts/docs-check.mjs (zero-dependency; five checks: orphan pages, broken relative links, unlabelled code fences, banned strings, oversized referenced images) + a GitHub Action on content PRs; npm run docs:check
  • Image hygiene: 59 unreferenced images deleted (−3.4 MB); oversized referenced images downscaled to ≤1600px (manifest in docs-review/reports/07-image-hygiene-manifest.md)

Build: ✓ 359 pages.


Backed by the multi-role docs review (master issue rustfs/backlog#1277; six full reports ship in the nav PR under docs-review/). Technical facts verified against rustfs/rustfs@ea2e24ac.

Rendered page previews (before / after)

/concepts/glossary
Before After
before after
/installation/console-first-steps (new page)

new

/installation/macos (new page)

new

/installation/windows (new page)

new

…CI, image hygiene

- New Console: First Steps tutorial reusing existing verified screenshots
- Windows/macOS: concrete download links (GitHub Releases / rustfs.com)
- Glossary: add SNSD/SNMD/MNMD entries; drop No. column; merge duplicate Storage Gateway entry
- scripts/docs-check.mjs + GitHub Action: orphan pages, broken relative links, unlabelled fences, banned strings, oversized images
- Delete 59 unreferenced images (-3.4 MB); resize oversized referenced images (manifest in docs-review reports)
Copilot AI review requested due to automatic review settings July 15, 2026 07:29
@vercel

vercel Bot commented Jul 15, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs-rustfs-com Ready Ready Preview, Comment Jul 15, 2026 7:33am

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jul 15, 2026

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
docs-rustfs-com cf95057 Commit Preview URL

Branch Preview URL
Jul 15 2026, 07:36 AM

Base automatically changed from overtrue/docs-p0-accuracy-fixes to main July 16, 2026 03:56
@overtrue
overtrue merged commit d87f65f into main Jul 16, 2026
3 of 4 checks passed
@overtrue
overtrue deleted the overtrue/docs-ci-images branch July 16, 2026 04:02
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