docs: reframe pitch as workload-agnostic and document workflow activation#77
Open
docs: reframe pitch as workload-agnostic and document workflow activation#77
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
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