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.

Sign up for GitHub

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

Jump to bottom

docs: Refactor whole "Docker Install" page #4667

Merged
merged 10 commits into from
Oct 29, 2024
Merged

docs: Refactor whole "Docker Install" page #4667

merged 10 commits into from
Oct 29, 2024

Conversation

ppawlowski
Copy link
Contributor

Description

This pull request improves the clarity and user-friendliness of the "Docker Install" page. It restructures the content with clearer step-by-step instructions, adds a dedicated prerequisites and FAQ sections, and uses consistent formatting for commands. These changes aim to simplify the installation process and enhance the overall user experience.

Related Issue(s)

closes #4632

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

@ppawlowski ppawlowski requested a review from joepavitt October 21, 2024 14:13
@ppawlowski ppawlowski mentioned this pull request Oct 21, 2024
Merged
10 tasks
@joepavitt
Copy link
Contributor

joepavitt commented Oct 21, 2024 •
edited
Loading

Screenshot 2024-10-21 at 16 50 24

Thoughts on the style @ppawlowski? I've pushed it to this branch, think it sets the tone quite nicely.

Realise the screenshot didn't quite capture properly, there is an interactive tooltip that disappears just as I take the screenshot, but the tick is still highlighted blue

@joepavitt joepavitt mentioned this pull request Oct 22, 2024
Merged
@ppawlowski ppawlowski requested a review from joepavitt October 23, 2024 12:01
@joepavitt
Copy link
Contributor

Not merging as that'll then bloat #4665

@ppawlowski ppawlowski requested a review from joepavitt October 28, 2024 07:44
@ppawlowski ppawlowski merged commit 36ab7ce into docs-docker-instal-refactor Oct 29, 2024
8 checks passed
@ppawlowski ppawlowski deleted the docs-docker-instal-reorder branch October 29, 2024 08:30
ppawlowski added a commit that referenced this pull request Oct 29, 2024
@ppawlowski @joepavitt
docs: Refactor instructions for installing FlowFuse on self-hosted en…
887a0a0 
…vironment using docker (#4665)

* docs: Refactor whole "Docker Install" page (#4667)

Co-authored-by: Joe Pavitt <joepavitt@flowforge.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joepavitt joepavitt joepavitt approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ppawlowski @joepavitt