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 Landing Page Restructure (first pass) #2438

Merged
merged 3 commits into from
Jul 8, 2023
Merged

Conversation

joepavitt
Copy link
Contributor

Description

Without restructuring the folders and content itself (that'll be my next step), this was a first pass at surfacing some of the important topic and trying to align with the major headlines flagged in FlowFuse/website#842

Related Issue(s)

FlowFuse/website#842

Checklist

@joepavitt joepavitt changed the title first pass (without restructuring folders) at making landing page a little more organised Docs Landing Page Restructure (first pass) Jul 7, 2023
@joepavitt joepavitt requested a review from ZJvandeWeg July 7, 2023 15:39
@@ -2,32 +2,55 @@
navTitle: Documentation
---

# FlowForge Docs
# Welcome to FlowForge

FlowForge helps Node-RED developers deliver applications in a more reliable,
Copy link
Member

Choose a reason for hiding this comment

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

It's be fine without the marketing blurb, or explaining this is not Node-RED development. Just FlowForge

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yeah, I left it in as was mostly focussed on structuring/grouping at the moment, but was tempted/happy to remove it too.

docs/README.md Outdated Show resolved Hide resolved
- [FlowForge Cloud](./cloud/) - details specific to the hosted service
- [Administrator documentation](./admin/) - how to administer the platform
- [User documentation](./user/) - how to use the platform
- [FlowForge Concepts](./user/concepts.md) - Understanding the core terminology and concepts that make up the FlowForge platform.
Copy link
Member

Choose a reason for hiding this comment

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

Styling wise, what do you think about using tables with bigger cells? I've tried this in https://deploy-preview-935--flowforge-website.netlify.app/handbook/ and found it appealing.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I really liked it. I held off on this, as I had already started the work by the time I saw it. Happy to do that tabling as a follow up PR once we've settled on ordering/grouping here.


## Upgrading FlowForge
## Upgrading & Billing
Copy link
Member

Choose a reason for hiding this comment

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

Billing is FF Cloud specific I think?

The two sections above we could rename to FlowForge Cloud and On-premise maybe, and merge these links to those sections?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah I grouped them together as they both covered money-based things. Upgrading > pay us money. Billing also seemed to cover details on how we bill customers generally, not just for FF Cloud?

docs/README.md Show resolved Hide resolved
joepavitt and others added 2 commits July 7, 2023 21:42
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>
@ZJvandeWeg ZJvandeWeg merged commit 27440fe into main Jul 8, 2023
1 check passed
@ZJvandeWeg ZJvandeWeg deleted the 842-docs-landing branch July 8, 2023 20:57
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.

2 participants