feat: make Cockpit easy to find, install and give feedback on - #179
Merged
Merged
Conversation
… › About A Feedback group in About opens GitHub: Report a problem and Sessions missing or wrong prefill the issue form with the Cockpit version, macOS version and architecture, and each agent CLI's version and install method — never paths, accounts or session content. Suggest an idea and Questions & discussion open their forms. AppInfo gains the macOS product version for it. The issue forms, a pull request template and a code of conduct come with it, so the repository's community profile is complete.
…er detour scripts/install.sh downloads the latest release for the Mac's architecture with curl, which sets no quarantine flag, verifies it against the SHA-256 digest GitHub recorded for the asset, checks the bundle id and version, and swaps it in beside any installed copy, putting the old one back on failure. It never reads latest-mac.yml, whose download count stands for installed copies checking for updates. Getting started and every release page now lead with the one-liner and the tashtit/tap Homebrew cask; the disk image and its Gatekeeper steps stay as the alternative.
stats reports adoption from what GitHub already records — outside feedback, traffic, and release downloads read by meaning (disk images, update zips, update checks) — and keeps a local history past GitHub's 14-day traffic window. No telemetry. ui:readme records the README's animated hero, its stills and the repository's social card from the ui-tour fixture world, so no real session, repo or account appears in them.
The guide in docs/ is deployed to GitHub Pages by docs.yml on pushes to main (pull requests only build it), with no analytics. The README opens with a recorded hero, the three reasons to use Cockpit, a one-line install, what it sends where, and where feedback goes; the code map moves to CONTRIBUTING.
Code Coverage OverviewLanguages: TypeScript TypeScript / code-coverage/unitThe overall line coverage in commit c72e772 in the Show a line coverage summary of the most impacted files.
TypeScript / code-coverage/componentThe overall line coverage in commit c72e772 in the Show a line coverage summary of the most impacted files.
Updated |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What and why
Hardly anyone outside the team has tried Cockpit yet: 8 unique repo visitors in two weeks (all arriving from github.com), 6 disk-image downloads ever, and no issues from outside the team. The README had no picture, the first install ran into Gatekeeper, and there was no feedback path, from inside the app or on GitHub. This PR fixes those three things.
Find it
docs/is published to GitHub Pages bydocs.ymlat https://tashtit.github.io/cockpit/ (base/cockpit/). It has no analytics, a sitemap, and a social card as itsog:image. Pull requests only build it, which fails on a dead link.npm run ui:readmerecords the pictures from the ui-tour fixture world, so no real session, repo or account appears in them:Install it
curl -fsSL https://raw.githubusercontent.com/tashtit/cockpit/main/scripts/install.sh | sh--dry-runshows what it would do.latest-mac.yml, so that file's download count keeps meaning "installed copies checking for updates".brew install --cask tashtit/tap/cockpitgoes through the new tashtit/homebrew-tap. Its cask PR isn't open yet; see below.Tell us
AppInfogainsosVersion.config.ymlpointing to Discussions and private security reports.Measure it
npm run statsreports:latest-mac.ymlfetches are update checks, which give an active-install rangeHow it was checked
npm run typecheck: clean.npm test: 1,388 unit tests (1 skipped) and 470 component tests pass.npm run docs:buildwith the new base: pages, sitemap andog:imagerender under/cockpit/.npm run ui:tour: 100 shots, none missing. About was checked at desktop size, 900×700, the 560×420 floor and 200% zoom. The a11y and window-minimum e2e specs were run against the build.install.sh:curl … | sh) against a local fake release: fresh install, upgrade, digest mismatch, missing digest, wrong bundle id, wrong version, a different app at the path, running app, dry run.npm run statswas run twice against this repo; the second run merged into the history instead of duplicating it.npm run dev).After merge
docs/public/readme/social-preview.pngunder Settings › General › Social preview.brewline works once the tap's cask lands.