Skip to content

Phase 1: Adding documentation metadata tags #6274

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
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

evankanderson
Copy link
Member

Proposed Changes

In preparation for a CNCF TechDocs Assessment, start labelling Knative documentation with metadata to assist with re-organizing content to different information architecture options (we will still need manual review, but this may simplify that review).

I'm using a schema with 3 fields:

field allowed values explanation
audience developer, administrator, buyer Who the target audience is; ensure documents have a clear, single audience
components eventing, functions, serving (list) What components are featured on the page.
function marketing, community, tutorial, how-to, reference, explanation A diataxis tag or "marketing" or "community" indicating the needs addressed by the documentation.

Copy link

netlify bot commented May 28, 2025

Deploy Preview for knative ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 6920614
🔍 Latest deploy log https://app.netlify.com/projects/knative/deploys/6837502b7d352500084af817
😎 Deploy Preview https://deploy-preview-6274--knative.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.

@knative-prow knative-prow bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label May 28, 2025
Copy link

knative-prow bot commented May 28, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: evankanderson

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@knative-prow knative-prow bot requested review from skonto and zainabhusain227 May 28, 2025 18:04
@knative-prow knative-prow bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 28, 2025
@evankanderson
Copy link
Member Author

https://diataxis.fr/complex-hierarchies/#two-dimensional-problems may be helpful when figuring out how to structure these eventually.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant