Skip to content
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

Documentation for generating reference docs inside a container #44055

Closed
wants to merge 1 commit into from
Closed

Documentation for generating reference docs inside a container #44055

wants to merge 1 commit into from

Conversation

Gauravpadam
Copy link
Member

Extension of #44029

This PR documents the approach for the containerized generation of reference docs, In case users want to generate the documentation in a containerized environment

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Nov 23, 2023
@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Nov 23, 2023
@netlify Netlify
Copy link

netlify bot commented Nov 23, 2023 •
edited
Loading

✅ Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 3e2615c
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/656f278ac47d340008c1a98c
😎 Deploy Preview https://deploy-preview-44055--kubernetes-io-main-staging.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 site configuration.

@Gauravpadam Gauravpadam mentioned this pull request Nov 23, 2023
Closed
sftim
sftim reviewed Nov 23, 2023
View reviewed changes
Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

Thanks. I have some feedback - see inline comments.

content/en/docs/contribute/generate-ref-docs/quickstart.md Outdated Show resolved Hide resolved
content/en/docs/contribute/generate-ref-docs/quickstart.md Outdated Show resolved Hide resolved
content/en/docs/contribute/generate-ref-docs/quickstart.md Show resolved Hide resolved
content/en/docs/contribute/generate-ref-docs/quickstart.md Outdated Show resolved Hide resolved
content/en/docs/contribute/generate-ref-docs/quickstart.md Outdated Show resolved Hide resolved
content/en/docs/contribute/generate-ref-docs/quickstart.md Outdated Show resolved Hide resolved
content/en/docs/contribute/generate-ref-docs/quickstart.md Outdated Show resolved Hide resolved
content/en/docs/contribute/generate-ref-docs/quickstart.md Outdated Show resolved Hide resolved
content/en/docs/contribute/generate-ref-docs/quickstart.md Outdated
Comment on lines 315 to 319
Beyond this point, The generation is completed.
Contributors can follow the trailing steps in the local environment build tutorial
to verify and commit the changes
Copy link
Contributor

Choose a reason for hiding this comment

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

I would explain the steps, even if it means repeating some.

content/en/docs/contribute/generate-ref-docs/quickstart.md Outdated Show resolved Hide resolved
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign kbhawkey for approval. For more information see the Kubernetes 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

@Gauravpadam
Copy link
Member Author

Could I get another review please?

@Gauravpadam Gauravpadam mentioned this pull request Dec 27, 2023
Closed
@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle stale
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Mar 4, 2024
@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough active contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle rotten
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

@k8s-ci-robot k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Apr 3, 2024
@Gauravpadam
Copy link
Member Author

/close

@k8s-ci-robot
Copy link
Contributor

@Gauravpadam: Closed this PR.

In response to this:

/close

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/test-infra repository.

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

@onlydole onlydole Awaiting requested review from onlydole

@tengqm tengqm Awaiting requested review from tengqm

@sftim sftim Awaiting requested review from sftim

Assignees
No one assigned
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@Gauravpadam @k8s-ci-robot @k8s-triage-robot @sftim