headlamp icon indicating copy to clipboard operation
headlamp copied to clipboard

Create an FAQ for Headlamp

Open joaquimrocha opened this issue 1 year ago • 5 comments

There are many questions related to Headlamp that are common to those not familiar with the project. We want to create an FAQ section in the docs and link it from relevant places.

Acceptance Criteria

  • [ ] We have an FAQ section in the docs
  • [ ] We have a link to the FAQ section in the README
  • [ ] We have a link to the FAQ section in the webpage's footer

joaquimrocha avatar Oct 18 '23 10:10 joaquimrocha

Hey @joaquimrocha i would love to contribute , are the faqs already written or should I search for them , it's my first time contributing here would appreciate any guidance

RISHIKESHk07 avatar Oct 28 '23 15:10 RISHIKESHk07

We have some ideas but we definitely don't have them written down yet. Maybe a collaborative doc would be best, but a PR can also work. It'd be in the docs/ folder. We can move it to the right place if we don't get the location right the first time.

joaquimrocha avatar Oct 28 '23 16:10 joaquimrocha

Just to be a bit more clear: we'd appreciate your contributions for sure. Check out the docs and let me know if you need more guidance.

joaquimrocha avatar Oct 28 '23 16:10 joaquimrocha

@joaquimrocha could you please tell me where the footer is

RISHIKESHk07 avatar Oct 30 '23 11:10 RISHIKESHk07

@joaquimrocha could you please tell me where the footer is

Hi @RISHIKESHk07 , sorry for the delay in replying. I was on vacation. The footer in headlamp's website is configured in the conifg.yaml file (look for footer there)

joaquimrocha avatar Nov 07 '23 20:11 joaquimrocha