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 landing page #842

Closed
3 of 6 tasks
ZJvandeWeg opened this issue Jun 12, 2023 · 3 comments · Fixed by FlowFuse/flowfuse#2650
Closed
3 of 6 tasks

Improve docs landing page #842

ZJvandeWeg opened this issue Jun 12, 2023 · 3 comments · Fixed by FlowFuse/flowfuse#2650
Assignees
Labels
area:docs Improvements or additions to documentation needs-triage Needs looking at to decide what to do size:M - 3 Sizing estimation point story A user-oriented description of a feature
Milestone

Comments

@ZJvandeWeg
Copy link
Member

ZJvandeWeg commented Jun 12, 2023

Description

As a: new or existing user of FlowForge,

I want to: quickly find answers on how to get the most out of the platform

So that: I can effectively use FlowForge.


Acceptance Criteria

  • Separate documentation structure based on use-cases
    • Current docs are focussed on user vs admin, not use-case
  • Improve structure so the left menu bar is use-case based
  • Link to community forum from the landing page
  • More prominent search box
  • Getting started guide for each use-case

Proposed structure

  1. FlowForge user how to
    1. Team management
    2. Application, how to build one
    3. Migration from Node-RED to FF NR
    4. Instance settings
    5. Security features
    6. .. etc for each feature
  2. Device Agent (Edge compute agent)
    1. How to install
    2. How to use
    3. Point to point data transfer
    4. Upgrade agent
    5. Roll out security updates
  3. Self-Managed FlowForge
    1. Marketplaces
    2. Local / Docker / K8S
    3. SSO
  4. FF Cloud
    1. Billing
    2. Stacks
    3. Templates
    4. Network
    5. SSO
  5. how to get support
    1. Community

Examples:

  1. https://docs.gitlab.com/
  2. https://stripe.com/docs
  3. https://docs.netlify.com/

Have you provided an initial effort estimate for this issue?

I have provided an initial effort estimate

@ZJvandeWeg ZJvandeWeg added story A user-oriented description of a feature size:M - 3 Sizing estimation point labels Jun 12, 2023
@MarianRaphael MarianRaphael added the area:docs Improvements or additions to documentation label Jun 12, 2023
@MarianRaphael MarianRaphael added this to the 1.9 milestone Jun 12, 2023
@MarianRaphael MarianRaphael added the needs-triage Needs looking at to decide what to do label Jun 13, 2023
@MarianRaphael MarianRaphael modified the milestones: 1.9, 1.10 Jul 6, 2023
@joepavitt
Copy link
Contributor

Looking into the Algolia analyttics, seems our most common search terms are:

  • device
  • sso
  • email
  • mqtt
  • git
  • agent
  • export

@joepavitt
Copy link
Contributor

really trying to work out how to have a first iteration at this, and struggling to bitesize it. Going to need to be shifting around a fair few files.

@MarianRaphael
Copy link
Contributor

First Iteration see: FlowFuse/flowfuse#2646

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 needs-triage Needs looking at to decide what to do size:M - 3 Sizing estimation point story A user-oriented description of a feature
Projects
Status: Next
Archived in project
Development

Successfully merging a pull request may close this issue.

4 participants