docs: reframe pitch as workload-agnostic and document workflow activation#77
Merged
Merged
Conversation
…tion - reframe README, plugin.json, intro, vision around any Azure workload - add .exampleyml activation callouts on workflow pages and onboarding - fix install snippet to use git-ape@git-ape across docs - remove stale git-ape-drift / ttl-reaper refs from verify workflow - add AI knowledge-base and streaming data platform examples - move azure-rest-api-reference to Pre-Deploy in generator 📚 - Generated by Copilot
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates Git-Ape’s documentation to position the project as workload-agnostic (any Azure workload), documents the *.exampleyml → *.yml workflow activation convention, refreshes workflow documentation pages via the docs generator, and adds new end-to-end deployment examples.
Changes:
- Reframes the project pitch across README/plugin docs to emphasize “any Azure workload” and removes stale workflow references.
- Documents workflow activation (renaming
*.exampleymlto*.yml) in onboarding + workflow docs, and updates the docs generator to emit activation callouts. - Adds new deployment examples and regenerates workflow reference pages to reflect current
.github/workflows/*.
Show a summary per file
| File | Description |
|---|---|
website/docs/workflows/pr-validation.md |
Adds auto-generated documentation page for the PR validation workflow. |
website/docs/workflows/overview.md |
Updates workflow inventory and adds an activation-required callout. |
website/docs/workflows/issue-triage-agent-lock.md |
Adds auto-generated documentation page for the issue triage agent lock workflow. |
website/docs/workflows/git-ape-verify.md |
Documents activation requirement for the git-ape-verify.exampleyml workflow and removes stale workflow references. |
website/docs/workflows/git-ape-release.md |
Adds auto-generated documentation page for the plugin release workflow. |
website/docs/workflows/git-ape-plugin-version-check.md |
Adds auto-generated documentation page for the plugin version drift check workflow. |
website/docs/workflows/git-ape-plan.md |
Adds activation-required callout for the plan workflow documentation page. |
website/docs/workflows/git-ape-docs.md |
Updates docs workflow page to reflect current action versions/node versions. |
website/docs/workflows/git-ape-docs-check.md |
Updates docs-check workflow page to reflect current action versions/node versions. |
website/docs/workflows/git-ape-destroy.md |
Adds activation-required callout for the destroy workflow documentation page. |
website/docs/workflows/git-ape-deploy.md |
Adds activation-required callout for the deploy workflow documentation page. |
website/docs/workflows/git-ape-build.md |
Adds auto-generated documentation page for the extension build workflow. |
website/docs/workflows/git-ape-actionlint.md |
Adds auto-generated documentation page for the workflow lint workflow. |
website/docs/workflows/daily-repo-status-lock.md |
Adds auto-generated documentation page for the daily repo status lock workflow. |
website/docs/vision.md |
Adjusts the vision/pitch text to emphasize workload-agnostic deployments. |
website/docs/use-cases/import-existing-infra.md |
Removes a stale use-case reference. |
website/docs/use-cases/deploy-anything.md |
Adds two new end-to-end deployment examples with diagrams and prompts. |
website/docs/skills/overview.md |
Moves azure-rest-api-reference into the Pre-Deploy phase and updates the phase diagram. |
website/docs/skills/azure-rest-api-reference.md |
Updates the skill “Phase” classification to Pre-Deploy. |
website/docs/reference/plugin-json.md |
Updates the documented plugin manifest description and keywords to match the new positioning. |
website/docs/reference/marketplace.md |
Updates marketplace documentation to include the additional plugin entry. |
website/docs/personas/for-engineers.mdx |
Updates Copilot CLI install snippet for consistency with other docs. |
website/docs/intro.md |
Reframes the intro pitch as workload-agnostic and fixes CLI install snippet. |
website/docs/getting-started/onboarding.md |
Adds explicit workflow activation guidance as part of onboarding. |
scripts/generate-docs.js |
Updates skill phase classification and adds activation-required callouts to generated workflow pages and overview. |
README.md |
Reframes the project pitch, updates skill/workflow descriptions, and refreshes included components listing. |
plugin.json |
Updates plugin description and keywords to match workload-agnostic positioning. |
.github/workflows/git-ape-verify.exampleyml |
Removes stale workflow entries from the verify workflow’s internal workflow list. |
Copilot's findings
- Files reviewed: 28/28 changed files
- Comments generated: 4
typo fix Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
readability Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
|
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.
Summary
Documentation audit fixes — reframe the project pitch as workload-agnostic (any Azure workload), document the
.exampleyml → .ymlactivation convention, fix install snippets, remove stale workflow references, and add two new end-to-end deployment examples.Changes
Pitch (workload-agnostic)
README.md,plugin.json,website/docs/intro.md,website/docs/vision.md— removed enumerations of workload types from lead sentences and "Built for" bulletsplugin.jsonkeywords: droppedinfrastructure/iac, addedworkloads/copilot-agentsWorkflow activation
:::info[Activation required]callouts to the workflows overview and each*.exampleymlpage explaining the rename step performed by/git-ape-onboardingwebsite/docs/getting-started/onboarding.mdInstall snippet consistency
copilot plugin installform acrossintro.mdandpersonas/for-engineers.mdxto usegit-ape@git-apeand addedcopilot plugin liStale references removed
git-ape-drift.ymlandgit-ape-ttl-reaper.ymlfrom the WORKFLOWS array in.github/workflows/git-ape-verify.exampleyml@azure-iac-generatorrow fromuse-cases/import-existing-infra.mdExamples
use-cases/deploy-anything.mdGenerator
scripts/generate-docs.js: movedazure-rest-api-referenceto Pre-Deploy phase; emits activation callout for.exampleymlpages.github/workflows/Validation
node scripts/validate-structure.js→ PASSEDnpm run build(Docusaurus) → SUCCESSactionlint -config-file .github/actionlint.yaml→ clean