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

Revise main documentation page #8019

Merged
merged 1 commit into from
Dec 12, 2021

Conversation

sftim
Copy link
Contributor

@sftim sftim commented Dec 7, 2021

  • Revise to be more in line with the style guide for Kubernetes official docs
  • Avoid recommending that readers use k8s.io namespaced controller names for their own custom controller configuration.
    (Rather than a name like k8s.io/ingress-nginx1, readers should either use a private name: ingress-nginx1, or use their own domain as a prefix).

Rendered

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. needs-kind Indicates a PR lacks a `kind/foo` label and requires one. needs-priority size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Dec 7, 2021
@sftim
Copy link
Contributor Author

sftim commented Dec 7, 2021

/kind documentation

@k8s-ci-robot k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. and removed needs-kind Indicates a PR lacks a `kind/foo` label and requires one. labels Dec 7, 2021
@longwuyuan
Copy link
Contributor

/ok-to-test
/lgtm

@longwuyuan
Copy link
Contributor

need to squash commits using bot before approve

@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 Dec 8, 2021
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 8, 2021
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 8, 2021
@sftim
Copy link
Contributor Author

sftim commented Dec 8, 2021

BTW, Prow can preserve LGTM through squashes - see kubernetes/kubernetes#103096 for hints.

@longwuyuan
Copy link
Contributor

longwuyuan commented Dec 8, 2021 via email

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 8, 2021
Copy link
Member

@tao12345666333 tao12345666333 left a comment

Choose a reason for hiding this comment

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

Thanks!

docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 8, 2021
@sftim
Copy link
Contributor Author

sftim commented Dec 8, 2021

Thanks for the extra suggestions @tao12345666333

docs/index.md Outdated
@@ -1,31 +1,35 @@
# Welcome
# NGINX Ingress Controller
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Alternatives:

  • Leave # Welcome
  • Switch to # Overview

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This will revise the heading on https://kubernetes.github.io/ingress-nginx/

Copy link
Member

Choose a reason for hiding this comment

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

I like # Overview

docs/index.md Outdated Show resolved Hide resolved
docs/index.md Show resolved Hide resolved
- Revise to be more in line with the style guide for Kubernetes official docs
- Avoid recommending that readers use `k8s.io` namespaced controller names
  for their own custom controller configuration.

Co-authored-by: James Strong <strong.james.e@gmail.com>
Copy link
Member

@tao12345666333 tao12345666333 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 Dec 8, 2021
@iamNoah1
Copy link
Contributor

iamNoah1 commented Dec 8, 2021

/triage accepted
/priority important-soon
/kind documentation

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. needs-priority labels Dec 8, 2021
@rikatz
Copy link
Contributor

rikatz commented Dec 12, 2021

/approve

Thanks :)

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: longwuyuan, rikatz, sftim, tao12345666333

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 12, 2021
@k8s-ci-robot k8s-ci-robot merged commit ec21629 into kubernetes:main Dec 12, 2021
rchshld pushed a commit to joomcode/ingress-nginx that referenced this pull request May 19, 2023
- Revise to be more in line with the style guide for Kubernetes official docs
- Avoid recommending that readers use `k8s.io` namespaced controller names
  for their own custom controller configuration.

Co-authored-by: James Strong <strong.james.e@gmail.com>

Co-authored-by: James Strong <strong.james.e@gmail.com>
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. area/docs cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants