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

Doc Updates: Device Agent #2440

Merged
merged 7 commits into from
Jul 9, 2023
Merged

Doc Updates: Device Agent #2440

merged 7 commits into from
Jul 9, 2023

Conversation

joepavitt
Copy link
Contributor

@joepavitt joepavitt commented Jul 7, 2023

Description

In addition to the below, this also fixes a error count check that has meant docs tests have passed when only one error is found. This was disguising a reported error for /support - which is valid for the website, and just needed adding to our exemption list.

Core Work:

Extracts Device documentation into separate files, driven by the phases that a user will go through in order to install, configure, run and deploy to Devices.

Screenshot 2023-07-07 at 21 53 00

Also utilises the new navOrder and redirect functionality introduced in FlowFuse/website#943 for the documentation

Related Issue(s)

Part of FlowFuse/website#842

Checklist

Labels

  • Backport needed? -> add the backport label

joepavitt and others added 4 commits July 7, 2023 16:37
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>
@joepavitt joepavitt requested a review from ZJvandeWeg July 7, 2023 20:52
@joepavitt
Copy link
Contributor Author

Not sure if we're backporting these documentation changes, don't think we need too personally, as will also be a lot more coming, but I'm breaking them into smaller PRs for reviewability.

@joepavitt
Copy link
Contributor Author

joepavitt commented Jul 7, 2023

Will fix these doc link errors found in the tests next week, I'm calling it a night for now (and am out til Thursday), but just wanted to at least get the basic restructure in.

Will also need to reverse the navOrder values given we're now reversing the order (see: FlowFuse/website#943 (comment))

@joepavitt
Copy link
Contributor Author

@ZJvandeWeg this is good to go now - note npm run test:docs fix too.

@ZJvandeWeg ZJvandeWeg merged commit 02f48e7 into main Jul 9, 2023
1 check passed
@ZJvandeWeg ZJvandeWeg deleted the 842-docs-device-agent branch July 9, 2023 06:24
@knolleary
Copy link
Member

This PR has removed https://flowforge.com/docs/user/devices/ but I don't see any redirects for that URL to take users to the new URL. That will break all existing links.

There are 6 links within the FlowForge application to that URL this PR will break. We cannot backport these changes without a redirect as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants