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

Refactor "Install FlowFuse on Kubernetes" documentation #4634

Closed
Tracked by #4310
ppawlowski opened this issue Oct 10, 2024 · 0 comments · Fixed by #4704
Closed
Tracked by #4310

Refactor "Install FlowFuse on Kubernetes" documentation #4634

ppawlowski opened this issue Oct 10, 2024 · 0 comments · Fixed by #4704
Assignees
Labels
area:docs Improvements or additions to documentation

Comments

@ppawlowski
Copy link
Contributor

ppawlowski commented Oct 10, 2024

From notes:

  • documentation is chaotic
    • some information about possible configuration is showed after installation is made (enabling mqtt and file-store), this is confusing
    • some very specific configurations examples are mentioned which may increase the confusion
  • Configuring Flowfuse/First Run Setup - we should consider moving it to the same level as Installing Flowfuse and Upgrading Flowfuse and use it as a starting point for configuration-related FAQ
  • typo in forge.localPostrgresql
  • This is done by creating a customization.yml file in the helm directory - there is no need to create helm directory and keep customization.yml there.

Like with Docker setup, I would aim to make installation as simple as possible. I would hide stuff related to more specific configuration behind drop-down FAQ or dedicated configuration-related page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:docs Improvements or additions to documentation
Projects
Status: Closed / Done
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant