-
Notifications
You must be signed in to change notification settings - Fork 29
[AIAA] Add the assessment request intake form #371
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
nate-double-u
wants to merge
2
commits into
cncf:main
Choose a base branch
from
nate-double-u:build/03-intake
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+142
−0
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,142 @@ | ||
| name: Documentation assessment request | ||
| description: Request an AI-assisted assessment of your project's documentation. | ||
| title: '[Assessment request]: ' | ||
| labels: | ||
| - Docs analysis | ||
| - needs-triage | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for your interest in a documentation assessment. | ||
|
|
||
| Filing this request does not start an assessment. It gathers | ||
| context. A technical writer triages every request and | ||
| explicitly accepts it before any work begins. | ||
|
|
||
| Assessments produced through this process are AI-drafted and | ||
| human-reviewed: an AI agent writes the draft, and a technical | ||
| writer reviews every finding before anything is published. The | ||
| project contacts named below are notified on this issue before | ||
| drafting begins. | ||
| - type: input | ||
| id: project-name | ||
| attributes: | ||
| label: Project name | ||
| description: The CNCF project to assess. | ||
| validations: | ||
| required: true | ||
| - type: dropdown | ||
| id: maturity | ||
| attributes: | ||
| label: Current CNCF maturity level | ||
| description: The project's level today. | ||
| options: | ||
| - Sandbox | ||
| - Incubating | ||
| - Graduated | ||
| validations: | ||
| required: true | ||
| - type: dropdown | ||
| id: moving-levels | ||
| attributes: | ||
| label: Is this project applying to move levels? | ||
| description: | ||
| If yes, the assessment runs against the next level's criteria; otherwise | ||
| against the current level's. | ||
| options: | ||
| - 'No' | ||
| - 'Yes' | ||
| default: 0 | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| id: website | ||
| attributes: | ||
| label: Project website | ||
| placeholder: https://example.io | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| id: docs-url | ||
| attributes: | ||
| label: Documentation site | ||
| description: Leave blank if the documentation lives on the website above. | ||
| validations: | ||
| required: false | ||
| - type: input | ||
| id: repo | ||
| attributes: | ||
| label: Website or documentation repository | ||
| placeholder: https://github.com/org/repo | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: other-scope | ||
| attributes: | ||
| label: Other repositories or sites in scope | ||
| description: | ||
| Demo servers, governance sites, or other repositories the assessment | ||
| should cover. One per line. | ||
| validations: | ||
| required: false | ||
| - type: textarea | ||
| id: out-of-scope | ||
| attributes: | ||
| label: Out of scope | ||
| description: Anything the assessment should not cover, and why. | ||
| validations: | ||
| required: false | ||
| - type: textarea | ||
| id: domains | ||
| attributes: | ||
| label: Documentation domains | ||
| description: | ||
| Every domain the assessment needs to read, one per line, for example the | ||
| documentation site and any demo or governance sites. The assessing agent | ||
| runs behind a firewall and can only reach domains added to its | ||
| allowlist; these entries are added at acceptance and removed afterward. | ||
| placeholder: | | ||
| docs.example.io | ||
| demo.example.io | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: contacts | ||
| attributes: | ||
| label: Project contacts | ||
| description: | ||
| GitHub handles of project community members available to help with the | ||
| assessment, one per line. They are notified on this issue before | ||
| drafting begins. | ||
| placeholder: '@community-member' | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| id: tooling | ||
| attributes: | ||
| label: Site tooling | ||
| description: | ||
| Static site generator, theme, and hosting, if you know them, for example | ||
| Hugo with Docsy on Netlify. | ||
| validations: | ||
| required: false | ||
| - type: textarea | ||
| id: context | ||
| attributes: | ||
| label: Anything else | ||
| description: | ||
| Context that would help the assessment, such as known problem areas or | ||
| recent documentation work. | ||
| validations: | ||
| required: false | ||
| - type: checkboxes | ||
| id: disclosure | ||
| attributes: | ||
| label: AI involvement disclosure | ||
| options: | ||
| - label: | ||
| I understand this assessment will be AI-drafted and human-reviewed, | ||
| and that the project contacts named above will be notified before | ||
| drafting begins. | ||
| required: true | ||
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.
Uh oh!
There was an error while loading. Please reload this page.