OpenFn / OpenFn/docs

document `super admin` features & permissions

Open
#455 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
23
Forks
20
Avg merge
3d 1h
Merged PRs (30d)
6

Description

Right now, the docs on docs.openfn.org cater to OpenFn SaaS users (as only our team is super admin of the hosted instance).

For users that are deploying OpenFn on their own instance, we should consider where to document features and permissions specific to super admin users (e.g., adding users, modifying platform limits, deployment tips & tricks).

  • We should consider where to document features and permissions specific to super admin users (e.g., adding users, modifying platform limits, deployment tips & tricks). Maybe these super admin docs should live on the main repo's README (https://github.com/OpenFn/lightning), but we should align on a decision and make sure we start to actually write down super admin features.
  • I'd also like to see an updated user permissions table

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing docs on docs.openfn.org, especially the user roles and permissions page, and compare whether super admin guidance belongs there or in the main repo README. Document the agreed super admin features and permissions, including the requested deployment guidance, and update the user permissions table.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.