Add portfolio management docs#66
Merged
Merged
Conversation
9ae2ef5 to
ce60f94
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a portfolio-management documentation set: a new About projects concept page, a companion About tags concept page, two user guides (organizing hierarchies, managing versions), one administration guide (project retention), a new Projects reference page, and small cross-link/contract updates so existing pages point into the new set.
Changes:
- New Concepts pages for projects and tags, plus cross-links from access-control, component-policies, vulnerability-policies, and changes-in-v5.
- New user guides for organizing projects into hierarchies and managing project versions, plus a new admin guide for project retention; registered in their respective
.pagesnav files. - New
reference/projects.md(classifiers, collection logic, identity/identifiers, tags/properties, retention controls) and a "Surface language" section added tocontext/diataxis-contract.md.
Reviewed changes
Copilot reviewed 17 out of 29 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/concepts/projects.md | New concept page covering the project model, hierarchy, collection projects, versions, retention, ACL. |
| docs/concepts/tags.md | New concept page describing tags and how they differ from project properties. |
| docs/concepts/access-control.md | Adds a "See also" link to the new projects concept page. |
| docs/concepts/component-policies.md | Links "tags" to the new tags concept page. |
| docs/concepts/vulnerability-policies.md | Links "project tags" to the new tags concept page. |
| docs/concepts/changes-in-v5.md | Documents the new retention policies as a v5 change. |
| docs/concepts/.pages | Registers the two new concept pages in the nav. |
| docs/guides/user/organizing-projects.md | New guide on parents, collection projects, and collection logic. |
| docs/guides/user/managing-project-versions.md | New guide on cloning versions, the latest flag, retiring versions, retention. |
| docs/guides/user/.pages | Registers the two new user guides. |
| docs/guides/administration/configuring-project-retention.md | New admin guide for the retention maintenance task. |
| docs/guides/administration/.pages | Registers the retention admin guide. |
| docs/reference/projects.md | New reference page (classifiers, collection logic, identity, identifiers, tags/properties, retention). |
| docs/reference/permissions.md | Adds cross-links to the two new portfolio user guides. |
| docs/reference/badges.md | Notes UUID/(name, version)/name-only badge URL resolution. |
| docs/reference/.pages | Registers the new projects reference page. |
| context/diataxis-contract.md | Adds a "Surface language" section governing UI vs. API/config vocabulary per Diataxis type. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
ce60f94 to
3c39db5
Compare
Signed-off-by: nscuro <nscuro@protonmail.com>
3c39db5 to
bbc0c28
Compare
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.
No description provided.