headlamp icon indicating copy to clipboard operation
headlamp copied to clipboard

frontend docs: Add FAQ for headlamp docs

Open vyncent-t opened this issue 1 year ago • 7 comments

Introduce FAQ Section in Headlamp Documentation

Relates to issue #1473

Description

This PR introduces a Frequently Asked Questions (FAQ) section to the Headlamp documentation, aimed at addressing common questions and providing users with a quick reference guide. The FAQ is easily accessible via new links added to the README and the webpage's footer.

Changes

  • [x] Created an FAQ section within the Headlamp documentation.
  • [x] Added a link to the FAQ section in the project's README.
  • [x] Inserted a link to the FAQ section in the footer of the Headlamp webpage.

Verification

  • [x] Ensured the FAQ section is accessible and displays correctly within the documentation.
  • [x] Verified that the links in the README and webpage footer correctly redirect to the FAQ section.
  • [x] Conducted a review to confirm the FAQ content is accurate and addresses the most common questions.

vyncent-t avatar Nov 09 '23 16:11 vyncent-t

I could use some input on the parts that are considered WIP, I was aiming for likely questions but some I want to make sure they're right.

vyncent-t avatar Nov 09 '23 19:11 vyncent-t

@RISHIKESHk07, maybe you're interested in helping here.

joaquimrocha avatar Nov 10 '23 16:11 joaquimrocha

This does not add a FAQ item to the website footer. That will need to be done in the website repo.

illume avatar Jan 10 '24 15:01 illume

Link for the faq section https://github.com/headlamp-k8s/headlamp-website/tree/faq-section

vyncent-t avatar Jan 11 '24 16:01 vyncent-t

added changes and rebased from main

vyncent-t avatar Mar 15 '24 19:03 vyncent-t

Rebased to main

vyncent-t avatar Apr 16 '24 19:04 vyncent-t

improved answer via copilot @joaquimrocha

vyncent-t avatar Apr 22 '24 15:04 vyncent-t