Skip to content

docs: Update documentation with setup and usage guides #554

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.

Sign up for GitHub

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

Jump to bottom
Open
deepsm007 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Update documentation with setup and usage guides #554

deepsm007 wants to merge 1 commit into from
+577 −0

Conversation

@deepsm007
Copy link
Contributor

@deepsm007 deepsm007 commented Nov 20, 2025

Add comprehensive setup and usage documentation pages:

  • setup.md: Step-by-step development environment setup guide
    • Prerequisites and installation steps
    • Development environment configuration
    • Local Kubernetes cluster setup
    • Testing and troubleshooting
    • usage.md: Practical usage guide
    • Configuration examples
    • Component usage instructions
    • Job management
    • Plugin usage
    • Tide configuration
    • Deck UI guide
    • Troubleshooting and best practices

@deepsm007
docs: Update documentation with setup and usage guides
0ddd297 
Add comprehensive setup and usage documentation pages:
- setup.md: Step-by-step development environment setup guide
  - Prerequisites and installation steps
  - Development environment configuration
  - Local Kubernetes cluster setup
  - Testing and troubleshooting
- usage.md: Practical usage guide
  - Configuration examples
  - Component usage instructions
  - Job management
  - Plugin usage
  - Tide configuration
  - Deck UI guide
  - Troubleshooting and best practices
@netlify
Copy link

netlify bot commented Nov 20, 2025 •
edited
Loading

✅ Deploy Preview for k8s-prow ready!

Name Link
🔨 Latest commit 0ddd297
🔍 Latest deploy log https://app.netlify.com/projects/k8s-prow/deploys/691f33381f419400084108da
😎 Deploy Preview https://deploy-preview-554--k8s-prow.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.

@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Nov 20, 2025

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: deepsm007
Once this PR has been reviewed and has the lgtm label, please assign matthyx for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found 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

@k8s-ci-robot k8s-ci-robot added area/documentation Issues or PRs related to documentation needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Nov 20, 2025
@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Nov 20, 2025

Hi @deepsm007. Thanks for your PR.

I'm waiting for a github.com member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Nov 20, 2025
@matthyx
Copy link
Contributor

matthyx commented Nov 20, 2025

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Nov 20, 2025
@stmcginnis
Copy link
Contributor

stmcginnis commented Nov 23, 2025

Also redundant with the other PRs?

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

Reviewers

@krzyzacy krzyzacy Awaiting requested review from krzyzacy

@petr-muller petr-muller Awaiting requested review from petr-muller

Assignees

No one assigned

Labels

area/documentation Issues or PRs related to documentation cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. 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

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@deepsm007 @k8s-ci-robot @matthyx @stmcginnis