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

Improve docs around pipeline target types #3318

Merged
merged 22 commits into from
Jan 12, 2024

Conversation

Steve-Mcl
Copy link
Contributor

closes #3316

Description

  • List out the "Target Types" for a pipeline stage
  • List out the "Actions" for a pipeline stage
  • Additional info around device groups
  • Add feature availability for device groups

Related Issue(s)

#3316

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

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

@Steve-Mcl Steve-Mcl linked an issue Jan 10, 2024 that may be closed by this pull request
3 tasks
@ZJvandeWeg
Copy link
Member

@joepavitt can you assist from a user perspective? And we both do a pass?

docs/user/device-groups.md Outdated Show resolved Hide resolved
docs/user/device-groups.md Outdated Show resolved Hide resolved
docs/user/device-groups.md Outdated Show resolved Hide resolved
docs/user/concepts.md Outdated Show resolved Hide resolved
docs/user/device-groups.md Outdated Show resolved Hide resolved
docs/user/devops-pipelines.md Outdated Show resolved Hide resolved
docs/user/device-groups.md Outdated Show resolved Hide resolved
docs/user/devops-pipelines.md Show resolved Hide resolved
docs/user/device-groups.md Show resolved Hide resolved
docs/user/device-groups.md Outdated Show resolved Hide resolved
Steve-Mcl and others added 5 commits January 11, 2024 14:40
Co-authored-by: Zeger-Jan van de Weg <ZJvandeWeg@users.noreply.github.com>
Co-authored-by: Zeger-Jan van de Weg <ZJvandeWeg@users.noreply.github.com>
Co-authored-by: Zeger-Jan van de Weg <ZJvandeWeg@users.noreply.github.com>
docs/user/device-groups.md Outdated Show resolved Hide resolved
docs/user/device-groups.md Show resolved Hide resolved
docs/user/device-groups.md Show resolved Hide resolved
docs/user/devops-pipelines.md Outdated Show resolved Hide resolved
docs/user/devops-pipelines.md Outdated Show resolved Hide resolved
docs/user/devops-pipelines.md Outdated Show resolved Hide resolved
docs/user/devops-pipelines.md Outdated Show resolved Hide resolved
docs/user/devops-pipelines.md Outdated Show resolved Hide resolved
Steve-Mcl and others added 8 commits January 11, 2024 15:12
Co-authored-by: Joe Pavitt <99246719+joepavitt@users.noreply.github.com>
Co-authored-by: Joe Pavitt <99246719+joepavitt@users.noreply.github.com>
Co-authored-by: Joe Pavitt <99246719+joepavitt@users.noreply.github.com>
@Steve-Mcl
Copy link
Contributor Author

@ZJvandeWeg @joepavitt I beleive I have addressed your many many many comments (yikes - didnt realise I was sooooo bad at docs!)

Can you both give it one last look over please so we can get it merged and I can pull/merge and finish up the PR on branch 3260-update-device-on-group-membership-change

Steve-Mcl and others added 2 commits January 11, 2024 15:47
Co-authored-by: Joe Pavitt <99246719+joepavitt@users.noreply.github.com>
@Steve-Mcl
Copy link
Contributor Author

Final tweaks complete.

@ZJvandeWeg
Copy link
Member

Thanks for the additional screenshots!

Steve-Mcl and others added 4 commits January 12, 2024 09:12
Co-authored-by: Zeger-Jan van de Weg <ZJvandeWeg@users.noreply.github.com>
Co-authored-by: Nick O'Leary <nick.oleary@gmail.com>
…e-target-types' into 3316-improve-docs-around-pipeline-target-types
@Steve-Mcl
Copy link
Contributor Author

Steve-Mcl commented Jan 12, 2024

@ZJvandeWeg

final wording around requirements is now:

The following requirements apply:

  • FlowFuse 1.15+ Enterprise Tier
  • FlowFuse Cloud teams on the Enterprise tier

Does this read how you expect/hope 🤞

EDIT:

Does this mean we should update other docs:

@joepavitt
Copy link
Contributor

Just pushed some formatting changes, the stage actions being H4's made the article difficult to read, so changed them to boldened bullets instead.

@Steve-Mcl Steve-Mcl merged commit 51e46dd into main Jan 12, 2024
9 checks passed
@Steve-Mcl Steve-Mcl deleted the 3316-improve-docs-around-pipeline-target-types branch January 12, 2024 10:08
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.

Improve docs around pipeline target types
4 participants