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

add faq section in docs #10003

Merged
merged 1 commit into from
May 28, 2023
Merged

add faq section in docs #10003

merged 1 commit into from
May 28, 2023

Conversation

longwuyuan
Copy link
Contributor

What this PR does / why we need it:

  • We don't have a generic FAQ section in docs
  • We do have one FAQ piece for migration to K8S 1.22 related to deprecation of ingress api v1beta1
  • Now we need a faq for the upcoming breaking change related to validation of the path field
  • This PR tries to introduce a generic FAQ section in docs
  • The FAQ section of the docs will hopefully go through lots of improvement iterations

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • CVE Report (Scanner found CVE and adding report)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation only

Which issue/s this PR fixes

fixes #9994

How Has This Been Tested?

  • Will improve as per feedback so no tests

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I've read the CONTRIBUTION guide
  • I have added unit and/or e2e tests to cover my changes.
  • All new and existing tests passed.

cc @strongjz @rikatz @tao12345666333 @ElvinEfendi

/triage accepted
/kind docs
/area documentation

@k8s-ci-robot k8s-ci-robot added the triage/accepted Indicates an issue or PR is ready to be actively worked on. label May 27, 2023
@k8s-ci-robot
Copy link
Contributor

@longwuyuan: The label(s) kind/docs, area/documentation cannot be applied, because the repository doesn't have them.

In response to this:

What this PR does / why we need it:

  • We don't have a generic FAQ section in docs
  • We do have one FAQ piece for migration to K8S 1.22 related to deprecation of ingress api v1beta1
  • Now we need a faq for the upcoming breaking change related to validation of the path field
  • This PR tries to introduce a generic FAQ section in docs
  • The FAQ section of the docs will hopefully go through lots of improvement iterations

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • CVE Report (Scanner found CVE and adding report)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation only

Which issue/s this PR fixes

fixes #9994

How Has This Been Tested?

  • Will improve as per feedback so no tests

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I've read the CONTRIBUTION guide
  • I have added unit and/or e2e tests to cover my changes.
  • All new and existing tests passed.

cc @strongjz @rikatz @tao12345666333 @ElvinEfendi

/triage accepted
/kind docs
/area documentation

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.

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-kind Indicates a PR lacks a `kind/foo` label and requires one. labels May 27, 2023
@k8s-ci-robot k8s-ci-robot added needs-priority area/docs approved Indicates a PR has been approved by an approver from all required OWNERS files. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels May 27, 2023
@longwuyuan
Copy link
Contributor Author

/kind documentation
/area docs

@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 May 27, 2023
@longwuyuan
Copy link
Contributor Author

/hold

@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 May 27, 2023
strongjz
strongjz requested changes May 27, 2023
View reviewed changes
Copy link
Member

@strongjz strongjz left a comment

Choose a reason for hiding this comment

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

I was thinking it would be it's own separate page, not on the index.

@longwuyuan
Copy link
Contributor Author

I was thinking it would be it's own separate page, not on the index.

Ok I will do that if you confirm.
I think that integrated with main content is relevant , including the css and panels etc. The subtopic are dedicated pages. Will wait to know.

@longwuyuan longwuyuan force-pushed the add-faq-section branch 2 times, most recently from de01b5e to 4e5e50e Compare May 28, 2023 12:52
@longwuyuan
Copy link
Contributor Author

@strongjz Ricardo also said not to build up on index page. So I moved the entire topic of faq to a new file /docs/faq.md . Links from within faq.md open other pages elsewhere.

Now I don't know how to link to the faq.md on the docs website as in with the green css and panels etc. Do I need t make edits in the gh-pages branch.

How to put up a clickable link in the top panel for faq.

@strongjz
Copy link
Member

CI should take care of that on merge.

@longwuyuan longwuyuan force-pushed the add-faq-section branch 2 times, most recently from d871122 to 055002a Compare May 28, 2023 14:05
@longwuyuan
Copy link
Contributor Author

CI should take care of that on merge.

ok. @strongjz Please review now and unhold or tell me what else needs to be done. I am still unsure if I have to write a href somewhere or some ghpages magic will add a link to the faq page on top or on the side.

@rikatz
Copy link
Contributor

rikatz commented May 28, 2023

@longwuyuan take a look at the "mkdocs.yml" file on root of repo ;)

@k8s-ci-robot k8s-ci-robot removed the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 28, 2023
@longwuyuan
Copy link
Contributor Author

@rikatz :-) problem solved after looking at mkdocs.yml

@strongjz Please review. Now its a dedicated page for faq with a link "FAQ" in the panel above (or so I think because I can't see it as it renderes on docs website with panel etc)

@strongjz
Copy link
Member

/lgtm
/approve
/unhold

We can always fix it if it doesn't format right.

Thank you @longwuyuan !

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label May 28, 2023
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 28, 2023
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: longwuyuan, strongjz

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 May 28, 2023
@k8s-ci-robot
Copy link
Contributor

New changes are detected. LGTM label has been removed.

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 28, 2023
@longwuyuan
Copy link
Contributor Author

@strongjz Wonder why this is not merging after removing hold.

@strongjz strongjz merged commit 5438968 into kubernetes:main May 28, 2023
33 of 34 checks passed
@strongjz
Copy link
Member

@strongjz Wonder why this is not merging after removing hold.

I merged it

@longwuyuan
Copy link
Contributor Author

ah ok. great.
looks like the new tab and page are in place. now for iterations on content

@longwuyuan longwuyuan deleted the add-faq-section branch May 28, 2023 18:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@strongjz strongjz strongjz requested changes

@cpanato cpanato Awaiting requested review from cpanato

@tao12345666333 tao12345666333 Awaiting requested review from tao12345666333

Assignees

@strongjz strongjz

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. needs-priority size/M Denotes a PR that changes 30-99 lines, ignoring generated files. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add FAQ section to documentation
4 participants
@longwuyuan @k8s-ci-robot @strongjz @rikatz