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.

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

DevEx: make live-docs script does not work #10927

Closed
domdomegg opened this issue Jan 28, 2024 · 6 comments · Fixed by #10928
Closed

DevEx: make live-docs script does not work #10927

domdomegg opened this issue Jan 28, 2024 · 6 comments · Fixed by #10928
Labels
area/docs kind/bug Categorizes issue or PR as related to a bug. kind/documentation Categorizes issue or PR as related to documentation. needs-priority needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one.

Comments

@domdomegg
Copy link
Contributor

domdomegg commented Jan 28, 2024

What happened:

I wanted to contribute to ingress-nginx documentation. I had a look through the make file to find the relevant command to preview the docs locally as I was developing them. I identified make live-docs as a potential candidate for doing this.

I therefore ran make live-docs, but this results in the error:

ERROR   -  Config value 'plugins': The "awesome-pages" plugin is not installed

What you expected to happen:

A live preview of the docs site to be available somewhere.

Environment:

  • OS (e.g. from /etc/os-release): Ubuntu 22.04.3 LTS
  • Kernel (e.g. uname -a): Linux 6.5.0-15-generic #15~22.04.1-Ubuntu SMP PREEMPT_DYNAMIC Fri Jan 12 18:54:30 UTC 2 x86_64 x86_64 x86_64 GNU/Linux

How to reproduce this issue:

Fresh clone of the git repository (@ 5acc423)

Install Go, Python and Docker:

  • go version go1.21.6 linux/amd64
  • Python 3.10.12
  • Docker version 25.0.1, build 29cf629

Anything else we need to know:

Also see discussion in https://kubernetes.slack.com/archives/C021E147ZA4/p1706448541824519

/area docs
/kind documentation

@domdomegg domdomegg added the kind/bug Categorizes issue or PR as related to a bug. label Jan 28, 2024
@k8s-ci-robot k8s-ci-robot added area/docs kind/documentation Categorizes issue or PR as related to documentation. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Jan 28, 2024
@k8s-ci-robot
Copy link
Contributor

This issue is currently awaiting triage.

If Ingress contributors determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

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.

@domdomegg
Copy link
Contributor Author

I think I have a fix for this, will raise PR soon.

@longwuyuan
Copy link
Contributor

As mentioned here https://kubernetes.slack.com/archives/C021E147ZA4/p1706448541824519, please submit the PR and it will generate a preview page

Thank you very much for contributing

/close

@k8s-ci-robot
Copy link
Contributor

@longwuyuan: Closing this issue.

In response to this:

As mentioned here https://kubernetes.slack.com/archives/C021E147ZA4/p1706448541824519, please submit the PR and it will generate a preview page

Thank you very much for contributing

/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.

@domdomegg
Copy link
Contributor Author

/reopen

@k8s-ci-robot
Copy link
Contributor

@domdomegg: Reopened this issue.

In response to this:

/reopen

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
Labels
area/docs kind/bug Categorizes issue or PR as related to a bug. kind/documentation Categorizes issue or PR as related to documentation. needs-priority needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one.
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants