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

docs: Self-hosted kubernetes installation page refactor #4704

Merged
merged 11 commits into from
Nov 11, 2024

Conversation

ppawlowski
Copy link
Contributor

Description

This pull request refactors documentation related to FlowFuse installation on Kubernetes environment.
New layout is aligned with a one applied on a Docker installation page. Also, it solves problems defined during evaluation of current installation description.

Related Issue(s)

Closes #4634

Checklist

  • I have read the contribution guidelines
  • Suitable unit/system level tests have been added and they pass
  • Documentation has been updated
    • Upgrade instructions
    • Configuration details
    • Concepts
  • Changes flowforge.yml?
    • Issue/PR raised on FlowFuse/helm to update ConfigMap Template
    • Issue/PR raised on FlowFuse/CloudProject to update values for Staging/Production

Labels

  • Includes a DB migration? -> add the area:migration label

Copy link
Contributor

@hardillb hardillb left a comment

Choose a reason for hiding this comment

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

Added some comments.

I'm still looking, but it's hard to render the check list locally in VSCode at the moment

docs/install/kubernetes/README.md Outdated Show resolved Hide resolved
docs/install/kubernetes/README.md Outdated Show resolved Hide resolved
@joepavitt
Copy link
Contributor

I'm still looking, but it's hard to render the check list locally in VSCode at the moment

If you run the website locally, you'll see it all rendered live.

ppawlowski and others added 2 commits November 6, 2024 10:50
Co-authored-by: Ben Hardill <ben@flowforge.com>
Co-authored-by: Ben Hardill <ben@flowforge.com>
Copy link
Contributor

@hardillb hardillb left a comment

Choose a reason for hiding this comment

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

A couple more suggestions, but looks good.

docs/install/kubernetes/README.md Outdated Show resolved Hide resolved
docs/install/kubernetes/README.md Outdated Show resolved Hide resolved
ppawlowski and others added 3 commits November 6, 2024 11:38
Co-authored-by: Ben Hardill <ben@flowforge.com>
Co-authored-by: Ben Hardill <ben@flowforge.com>
@joepavitt joepavitt merged commit e7ff0e6 into main Nov 11, 2024
9 checks passed
@joepavitt joepavitt deleted the docs-k8s-refactor branch November 11, 2024 13:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Refactor "Install FlowFuse on Kubernetes" documentation
3 participants