openfaas / openfaas/docs

Troubleshooting page updates or FAQ page

Open
#97 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Makefile
Stars
67
Forks
94
Avg merge
5h 51m
Merged PRs (30d)
1

Description

The toubleshooting guide has grown quite large, nearly 500 lines now. That's not a bad thing, but I believe it should be re-organized to make it easier to navigate. It's also a bit difficult to see the different headings on the docs page. Difference between ## and ### are very slight.

Currently, the topics are focused on how to do something:

  • Timeouts
  • Healthcheck
  • Watchdog

These are useful if you know what you're looking for, however, it's difficult to know what you need to do when something is wrong and you're not familiar with the project.

I propose the Troubleshooting guide be updated to a question/answer format to make it easier to find relevant information.

A good example of this is in the "Troubleshooting Swarm or Kubernetes" section: I forgot my gateway password

There have been a couple of conversations happening on Slack that have come up before. The members have linked to sections in the docs, but without knowing what to look for, the others have to ask.

Some examples of questions that came up (in the "openfaas" channel):

  • Why doesn't auto-scaling work like I expect it?
  • Why is my function not ready after faas-cli deploy?
  • How do I invoke a function via cron job?
  • How do I change the alert rules?
  • I can't access the UI on localhost

Possibly some of these could go into a new "FAQ" page. Those questions that aren't really problems but more curiosity...

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing Troubleshooting guide and its “Troubleshooting Swarm or Kubernetes” section, including the linked “I forgot my gateway password” example. Use the listed Slack questions to decide whether topics belong in a reorganized guide or a separate FAQ, and consider the work done when the information is easier to find and the heading hierarchy is clearer.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.