Skip to content

[AIAA] Add the assessment request intake form - #371

Open
nate-double-u wants to merge 2 commits into
cncf:mainfrom
nate-double-u:build/03-intake
Open

[AIAA] Add the assessment request intake form#371
nate-double-u wants to merge 2 commits into
cncf:mainfrom
nate-double-u:build/03-intake

Conversation

@nate-double-u

Copy link
Copy Markdown
Member

Adds .github/ISSUE_TEMPLATE/assessment-request.yml: the intake form
for AI-assisted documentation assessments. Build step 3 (spec section
16); fields per section 7, allowlist domains per section 11,
disclosure per HC-6. Tracking: #370.

What it collects

  • Project basics from the methodology's analysis template: name,
    CNCF maturity, website, docs site, repository, in and out of scope,
    tooling.
  • Documentation domains (required): the agent works behind a firewall,
    and these entries seed its allowlist at acceptance; an explicit,
    auditable, reversible contract per assessment.
  • Project contacts (required): notified on the intake issue before
    drafting begins, whoever filed (HC-6).

Guardrails in the form

  • The intro states that filing does not start an assessment; a
    technical writer triages and accepts (NG-5, P-1).
  • AI involvement is disclosed in the intro and acknowledged through a
    required checkbox (HC-6): no project discovers it after the fact.
  • Labels applied at filing: Docs analysis (existing convention) and
    needs-triage (added by the step 1 PR).

Verification

  • Assertion script (session artifact): 24 checks pass; YAML parses,
    required fields enforced, disclosure present, labels set.
  • npm run check passes.
  • Live dry-run after merge: file a request, confirm fields and labels,
    close it. Runs after the step 1 PR merges, or the needs-triage
    label drops silently.

Assisted-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Nate W <natew@cncf.io>
@netlify

netlify Bot commented Aug 14, 2026

Copy link
Copy Markdown

Deploy Preview for cncf-techdocs ready!

Name Link
🔨 Latest commit ad91530
🔍 Latest deploy log https://app.netlify.com/projects/cncf-techdocs/deploys/6a7f65a34810d90008b1a09f
😎 Deploy Preview https://deploy-preview-371--cncf-techdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@nate-double-u
nate-double-u requested a lite review from Copilot August 14, 2026 18:42
@nate-double-u
nate-double-u marked this pull request as ready for review August 14, 2026 18:42

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new GitHub Issue Form to collect intake information for AI-assisted documentation assessments, including required allowlist domains and an explicit AI-disclosure acknowledgement, aligning with the AIAA “step 3” intake-form requirement.

Changes:

  • Introduces a new issue form template for “Documentation assessment request”.
  • Captures project basics, in/out-of-scope context, required documentation domains, and required project contacts.
  • Adds a required checkbox to acknowledge AI involvement and sets default labels on submission.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread .github/ISSUE_TEMPLATE/assessment-request.yml

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

Suppressed comments (1)

.github/ISSUE_TEMPLATE/assessment-request.yml:33

  • The intake asks for an unspecified “CNCF maturity level,” but this codebase evaluates upgrade-request analyses against the proposed level (docs/analysis/howto.md:32-35). A requester can therefore select their current level when the writer actually needs the target level, causing the assessment to use the wrong rubric. Clarify that this field is the level to assess and direct upgrade requests to select the proposed level.
      label: CNCF maturity level

… level

Assisted-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Nate W <natew@cncf.io>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CI/infra CI & infrastructure

Projects

Development

Successfully merging this pull request may close these issues.

2 participants