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

Add static asset service user docs #4426

Merged
merged 8 commits into from
Sep 2, 2024
Merged

Conversation

cstns
Copy link
Contributor

@cstns cstns commented Aug 29, 2024

Description

Add static asset service user docs

Related Issue(s)

none

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

@cstns cstns self-assigned this Aug 29, 2024
@cstns cstns marked this pull request as draft August 29, 2024 16:40
@cstns cstns requested a review from joepavitt August 30, 2024 11:34
@joepavitt
Copy link
Contributor

Any reason for the draft? Or can I review?

@cstns
Copy link
Contributor Author

cstns commented Aug 30, 2024

There's an open question on dpt eng about some points in the docs that would need clarifying

@cstns
Copy link
Contributor Author

cstns commented Aug 30, 2024

about the limitations section*

@hardillb
Copy link
Contributor

hardillb commented Sep 2, 2024

@cstns how are we doing with this?

@cstns
Copy link
Contributor Author

cstns commented Sep 2, 2024

I need to update the limitations section.
I have an answer for Unsupported characters, which ill make a vague remark about depending on file system, but the other two remain unanswered:
- Allowed MIME types: // todo couldn't find any on the BE or localfs driver
- Team permissions required: owner // to be confirmed or rephrased

@hardillb
Copy link
Contributor

hardillb commented Sep 2, 2024

We do not care about mime types for the currently deployed code, everything is just uploaded as binary blob.

We may want to think about mime types for when sharing is enabled, but that is part of the next release (and we are going to default to what Node-RED already does).

@hardillb
Copy link
Contributor

hardillb commented Sep 2, 2024

Only Owner and Members should be able to access the Assests tab.

@cstns
Copy link
Contributor Author

cstns commented Sep 2, 2024

As we stand, viewer type roles have access to the assets tab, but cannot retrieve assets so the list is always empty. The asset action buttons are still enabled (refresh, new folder and upload).

Should I create another issue or do a quick fix in this one?

I can also remove the mime type restriction from the docs until we implement it.

@hardillb
Copy link
Contributor

hardillb commented Sep 2, 2024

Raise an issue for the Viewer stuff.

Remove the mime stuff

@cstns
Copy link
Contributor Author

cstns commented Sep 2, 2024

linking #4439

@cstns cstns requested a review from hardillb September 2, 2024 13:11
@cstns cstns marked this pull request as ready for review September 2, 2024 13:12
Copy link
Contributor

@hardillb hardillb left a comment

Choose a reason for hiding this comment

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

Also probably need a link from docs/users/index.md in the "Working with Files and Context" section

docs/user/static-asset-service.md Outdated Show resolved Hide resolved
docs/user/static-asset-service.md Outdated Show resolved Hide resolved
cstns and others added 3 commits September 2, 2024 16:42
Co-authored-by: Ben Hardill <ben@flowforge.com>
Co-authored-by: Ben Hardill <ben@flowforge.com>
@cstns cstns requested review from hardillb and removed request for joepavitt September 2, 2024 14:06
@hardillb
Copy link
Contributor

hardillb commented Sep 2, 2024

Raised follow up #4440 to clean up file node docs.

@hardillb hardillb merged commit dfff26a into main Sep 2, 2024
8 checks passed
@hardillb hardillb deleted the add-static-asset-service-user-docs branch September 2, 2024 14:28
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.

3 participants