Skip to content

Commit 46935bd

Browse files
committed
reverting changes to squad
1 parent 0829109 commit 46935bd

2 files changed

Lines changed: 0 additions & 52 deletions

File tree

.squad/agents/docwriter/history.md

Lines changed: 0 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -16,22 +16,6 @@ Documentation authoring (2026-04-30 to 2026-05-17): 3-phase plan with 28 user-fa
1616

1717
<!-- Append new learnings below this line -->
1818

19-
### 2026-06-11: Air-Gapped Walkthroughs — GitHub Actions and Azure DevOps
20-
21-
**Context:** Authored two walkthrough documents for using apiops-cli in air-gapped (network-restricted) environments.
22-
23-
**Files Created:**
24-
1. `docs/walkthrough/air-gapped-github-actions.md` — 8-step guide covering tarball preparation, `apiops init --cli-package`, lock file generation, npm cache transfer, self-hosted runner setup, workflow modifications for `npm ci --offline`, and upgrade procedures.
25-
2. `docs/walkthrough/air-gapped-azure-devops.md` — 9-step guide with same core pattern plus Azure Artifacts feed as alternative to manual cache transfer, `npmAuthenticate@0` task usage, agent pool configuration, and AzureCLI@2 service connection authentication.
26-
27-
**Files Updated:**
28-
- `docs/README.md` — Added walkthrough section to Quick Links table and directory tree.
29-
30-
**Learnings:**
31-
- Air-gapped setups rely on `--cli-package` flag for local tarball mode, which generates `package.json` with `"file:.apiops/{tarball}"` dependency. The lock file is critical — without it, `npm ci` fails.
32-
- Azure DevOps has a natural advantage for air-gapped setups via Azure Artifacts feeds with upstream sources (controlled sync windows). GitHub Actions environments must rely on pre-populated npm cache or vendored node_modules.
33-
- Authentication differs: GitHub Actions in air-gapped may lose OIDC (can't reach token.actions.githubusercontent.com), requiring fallback to service principal secrets. Azure DevOps service connections work regardless since the agent-to-DevOps connectivity handles token exchange.
34-
3519
### 2026-05-17: Phase 2 Docs — Azure DevOps, Filtering, Artifact Format, Config Reference, Glossary
3620

3721
**Context:** Authored five Phase 2 documentation files completing CI/CD coverage, resource filtering guide, artifact format reference, configuration reference, and APIM glossary.
@@ -131,21 +115,3 @@ Documentation authoring (2026-04-30 to 2026-05-17): 3-phase plan with 28 user-fa
131115
**Patterns:** Examples-first, Mermaid workflows, relative links, search-optimized errors, progressive disclosure
132116

133117
**Gotchas:** Auth flags set env vars (credential precedence). Overrides: names consistent, properties differ. `--commit-id`/`--delete-unmatched` exclusive.
134-
135-
### 2026-06-11: Air-Gapped Azure DevOps — PR Feedback Revision
136-
137-
**Context:** Revised `docs/walkthrough/air-gapped-azure-devops.md` based on PR review comments.
138-
139-
**Changes:**
140-
- Made local npm registry (Azure Artifacts) the primary/default approach; tarball flow demoted to fallback section.
141-
- Removed redundant "npm 10+" prerequisite (implied by Node.js 22.x).
142-
- Removed "transfer mechanism" prerequisite row (not needed when local registry is primary).
143-
- Added official Microsoft docs links: self-hosted agents, Azure Artifacts npm feeds, Azure DevOps Server on-prem, sovereign cloud identity endpoints.
144-
- Replaced full embedded pipeline YAML with concise edit table referencing generated files (`pipelines/run-extractor.yaml`, `pipelines/run-publisher.yaml`).
145-
- Added "Sovereign Clouds and On-Premises" section with doc links.
146-
- Simplified architecture diagram to reflect local registry flow.
147-
148-
**Learnings:**
149-
- PR reviewers strongly prefer docs that match the air-gapped reality: local registries over manual transfers. Azure Artifacts is a natural fit since it's bundled with Azure DevOps Server.
150-
- Large embedded YAML examples are fragile — they drift from generated templates. Better to describe minimal edits to the generated files.
151-
- Always link to official Microsoft docs for infrastructure setup (agents, feeds, sovereign clouds) rather than inlining instructions that will go stale.

.squad/decisions.md

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,6 @@
22

33
## Active Decisions
44

5-
### 2026-06-11T22:34:04Z: Air-Gapped Walkthrough Documentation Pattern
6-
**By:** DocWriter
7-
**Status:** Proposed
8-
**What:** Created a new `docs/walkthrough/` directory for scenario-based step-by-step guides that are more detailed than the standard CI/CD integration docs. First entries cover air-gapped deployments for both GitHub Actions and Azure DevOps.
9-
10-
**Decision:** Establish walkthrough pattern for complex multi-step deployment scenarios that don't fit cleanly into standard integration guides.
11-
12-
**Pattern:**
13-
- **`docs/walkthrough/`** = scenario-based, multi-step guides for specific deployment patterns
14-
- **`docs/ci-cd/`** = platform integration reference (standard setup)
15-
- **`docs/guides/`** = feature-oriented how-to guides
16-
17-
**Scope:** Future walkthrough candidates include multi-region APIM, sovereign cloud deployments, monorepo with multiple APIM instances. Any scenario requiring 5+ steps beyond the standard setup qualifies.
18-
19-
**Next Steps:** Team review; if approved, publish guides and update docs/README index.
20-
21-
---
22-
235
### 2026-05-14T05:20:00Z: APIM v1 → v2 SKU Migration via apiops-cli
246
**By:** ApimExpert + ApiOpsLead (joint research and decision)
257
**Status:** Proposed for team governance review

0 commit comments

Comments
 (0)