Skip to content

Website#77

Open
aliok wants to merge 8 commits intokubernetes-sigs:mainfrom
aliok:2026-04-08-website
Open

Website#77
aliok wants to merge 8 commits intokubernetes-sigs:mainfrom
aliok:2026-04-08-website

Conversation

@aliok
Copy link
Copy Markdown
Member

@aliok aliok commented Apr 8, 2026

Partiall fixes #14

This PR adds a documentation website for the MCP Lifecycle Operator, similar to the structure used by kube-agentic-networking.

The site can be viewed locally by running make live-docs (Docker) or ./hack/mkdocs/local-serve.sh (Python venv)

Tech:

  • MkDocs with Material for MkDocs theme
  • Netlify (configuration included in netlify.toml) --> Netlify project and domain needs to be set up by someone with admin access
  • API Documentation auto-generated from Go types using crd-ref-docs

Following the kube-agentic-networking model, we copied the CSS styling, theme configuration, build infrastructure and the general structure.

Verification:

make live-docs
# Starts server at http://localhost:3000

# or, Python virtual environment (faster)
./hack/mkdocs/local-serve.sh
#Starts server at http://127.0.0.1:3000

API reference is auto-generated from Go CRD types:

make api-ref-docs

Building for Production

  make build-docs          # Using Docker
  make build-docs-netlify  # Without Docker (for Netlify)

Output is generated in the site/ directory.

What needs to be done afterwards:

  • Set up Netlify deployment (requires admin access)
  • Configure custom domain (e.g., mcp-lifecycle-operator.sigs.k8s.io)

Signed-off-by: Ali Ok <aliok@redhat.com>
@k8s-ci-robot k8s-ci-robot requested review from matzew and soltysh April 8, 2026 08:57
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. approved Indicates a PR has been approved by an approver from all required OWNERS files. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Apr 8, 2026
@aliok
Copy link
Copy Markdown
Member Author

aliok commented Apr 8, 2026

@matzew wanna take a first look?

@matzew
Copy link
Copy Markdown
Member

matzew commented Apr 8, 2026

Very nice! :)

Signed-off-by: Ali Ok <aliok@redhat.com>
@aliok
Copy link
Copy Markdown
Member Author

aliok commented Apr 8, 2026

@matzew another look?

Copy link
Copy Markdown
Member

@matzew matzew left a comment

Choose a reason for hiding this comment

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

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 8, 2026
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: aliok, matzew

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

The pull request process is described here

Details 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

@matzew
Copy link
Copy Markdown
Member

matzew commented Apr 8, 2026

/ok-to-test

@k8s-ci-robot k8s-ci-robot added the ok-to-test Indicates a non-member PR verified by an org member that is safe to test. label Apr 8, 2026
@matzew
Copy link
Copy Markdown
Member

matzew commented Apr 8, 2026

/hold
for others to review

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Apr 8, 2026
@aliok
Copy link
Copy Markdown
Member Author

aliok commented Apr 8, 2026

cc @jaideepr97 wanna take a look?

aliok added 6 commits April 10, 2026 10:54
Signed-off-by: Ali Ok <aliok@redhat.com>
…y context structure

Signed-off-by: Ali Ok <aliok@redhat.com>
… handling

Signed-off-by: Ali Ok <aliok@redhat.com>
Signed-off-by: Ali Ok <aliok@redhat.com>
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 10, 2026
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

New changes are detected. LGTM label has been removed.

@k8s-ci-robot k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Apr 10, 2026
@aliok
Copy link
Copy Markdown
Member Author

aliok commented Apr 10, 2026

@Cali0707 I think I resolved all the comments you've made. Thanks for catching issues!

Another look? cc @matzew

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. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Project website

4 participants