docs: add private packages guide and enhance authentication page#314
docs: add private packages guide and enhance authentication page#314danielmeppiel merged 10 commits intomainfrom
Conversation
Co-authored-by: danielmeppiel <51440732+danielmeppiel@users.noreply.github.com>
Co-authored-by: danielmeppiel <51440732+danielmeppiel@users.noreply.github.com>
|
@copilot this is not satisfactory - the Authentication page itself should speak about the case of an object reference to gitURL and how git credential helpers work there. Also, the guide seems to repeat a lot of stuff from the Authentication page. rethink the structure as a world class technical writer for developer tooling without bloating the docs. |
…slim down private packages guide Co-authored-by: danielmeppiel <51440732+danielmeppiel@users.noreply.github.com>
Restructured in 9f6840e. Two changes:
|
There was a problem hiding this comment.
Pull request overview
Documentation update to close gaps around how APM authenticates to private git repositories and to provide a dedicated, workflow-focused guide for private packages.
Changes:
- Added a new “Private Packages” guide describing the end-to-end workflow (create → install → share → CI).
- Restructured the Authentication page to explain APM’s auth paths (token injection vs git credential helpers/SSH) and object-style
git:references. - Updated the docs sidebar to include the new guide.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 9 comments.
| File | Description |
|---|---|
| docs/src/content/docs/guides/private-packages.md | New workflow guide for creating and consuming private APM packages. |
| docs/src/content/docs/getting-started/authentication.md | Reorganized and expanded authentication documentation, including git: object references and setup scenarios. |
| docs/astro.config.mjs | Adds “Private Packages” to the Guides sidebar section. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Description
APM already supports private packages via git credentials, but the documentation had gaps: the Authentication page didn't explain how git credential helpers and
git:object references work, and there was no dedicated guide for the private packages workflow.This PR enhances the Authentication page to be the single source of truth for how APM authenticates, and adds a focused private packages guide that covers the workflow without duplicating auth details.
Authentication page (
docs/src/content/docs/getting-started/authentication.md) — restructured with:git:object references and how authentication applies to themPrivate packages guide (
docs/src/content/docs/guides/private-packages.md) — a concise workflow page (~70 lines) covering create → install → share → CI → org-wide, linking to Authentication for all auth details with no duplication.Sidebar (
docs/astro.config.mjs) — inserted "Private Packages" between Pack & Distribute and Org-Wide Packages.Type of change
Testing
📍 Connect Copilot coding agent with Jira, Azure Boards or Linear to delegate work to Copilot in one click without leaving your project management tool.