bazel-contrib / bazel-contrib/bazel-docs

Migration audit

Open
#391 1 comment 0 reactions 1 assignee Claimed by @armandomontanez View on GitHub
Dominant language
MDX
Stars
7
Forks
12
Avg merge
20h 49m
Merged PRs (30d)
31

Description

# Migration audit

## Methodology

1. Top 80% of pages were collected from Google Analytics.

2. Capture a screenshot of old page and new page with Playwright.

3. Visually diff the old page and new page with Gemini API.

4. I manually synthesized the visual diff data into the categories below.

## Issues

Ranked in order of importance, most important first.

### Missing content

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#conceptsdependencies

* Dependency graph diagrams are missing

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#docscc-toolchain-config-reference

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#querylanguage

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#releaserolling

### First column of tables is unusably narrow

Some of these pages seem to be important references.

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#ruleslibrepogit

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#ruleslibrepohttp

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#ruleslibrepolocal

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#referenceflag-cheatsheet

### Unusable content

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#referencebecommon-definitions

* See `Attributes common to all test rules` section

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#ruleslibbuiltinscclinkingoutputs

* Cross-links on types within code blocks are now just plaintext

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#ruleslibrepoutils

* Code blocks are merged onto single line e.g. `load` and `maybe` on same line

### Missing landing pages

The old site has landing pages that mainly serve to help you navigate
around the site. On the new site, all of these landing pages redirect
to a specific, contentful page of documentation.

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#about

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#community

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#extending

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#reference

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#start

### Raw HTML leaking into content

These can be pretty confusing because `` gets included as part of a code block.
And often users are expected to copy and use code blocks verbatim.

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#basicshermeticity

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#conceptslabels

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#configurebest-practices

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#configurewindows

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#docsandroid-ndk

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#externalextension

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#externalmodule

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#installdocker-container

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#installos-x

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#installsuse

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#installubuntu

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#installwindows

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#referencebeplatforms-and-toolchains

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#remotecache-remote

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#remotecaching

And more

### Inline code gets split across 2 lines

Relatively minor but pretty distracting.

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#advancedperformancebuild-performance-metrics

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#installbazelisk

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#installcompile-source

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#referencebeobjective-c

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#referenceflag-cheatsheet

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#releasebackward-compatibility

### Page metadata leaking at top of page

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#contributepolicy

### Unstyled admonitions e.g. note, warning, etc.

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#basics

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#basicshermeticity

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#communityusers

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#conceptsdependencies

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#conceptsplatforms

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#contributedocs-style-guide

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#extendinglegacy-macros

And more

### CLI code blocks no longer start with `$`

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#basicstask-based-builds

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#installwindows

### Missing images

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#communityexperts

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#communitypartners

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#communityusers

### Material UI label codes leaking into content

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#concepts

- [ ] https://github.com/kaycebasques/migrate/blob/bazel/REPORT.md#conceptslabels

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.