-
Notifications
You must be signed in to change notification settings - Fork 440
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
Rewrite docs on organizations and projects, with per-project permissions #1948
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @Twixes, this makes it a lot clearer! Minor comments inline, in addition project-based permissions should be an ee
feature (see https://github.com/PostHog/company-internal/issues/417)
Good points, addressed @paolodamico |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few small but worthwhile changes requested.
Generally really well explained.
Two main comments:
- The intro paragraph needs to do more to explain the value of these concepts and organisational constructs
- We should probably capitalise Organization and Project when being used as a noun
Co-authored-by: Phil Leggetter <phil@leggetter.co.uk>
Good points @leggetter, I'm not sure about capitalizing these words here though. |
Co-authored-by: Phil Leggetter <phil@leggetter.co.uk>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Made suggestions inline, but looking pretty solid!
Co-authored-by: Paolo D'Amico <paolodamico@users.noreply.github.com>
Alright, used some suggestions but also changed a few. @paolodamico I would suggest with this number of suggestions to just create a PR on top of the one being edited in the future, as an article loses cohesiveness with multiple individual-line edits. Added the PR to the Artwork board, not high priority, but it could be nice to have an illustration (referring to #1948 (comment)). |
|
||
### Private projects | ||
|
||
If you'd like to restrict access to data within the organization to only those who need it, you can make a project _private_. Projects with this setting enabled become **secret by default and invite-only** (except for Administrators and the Owner, who get access implicitly). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you'd like to restrict access to data within the organization to only those who need it, you can make a project _private_. Projects with this setting enabled become **secret by default and invite-only** (except for Administrators and the Owner, who get access implicitly). | |
If you'd like to restrict access to data within the organization to only those who need it, you can make a project _private_. Projects with this setting enabled become **private by default and invite-only** (except for Administrators and the Owner, who get access implicitly). |
I'm sorry, I know I made this suggestion but just realized secret implies that it's completely hidden from other members, but it's not secret (other team members can still see it exists and its name), it's private
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, I thought it was a conscious suggestion to make them secret in the product too, but very well, let's just keep them private as currently implemented.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's fine to keep it like this, we can get more feedback from users in the upcoming weeks as to whether there's a use case for secret projects, but my guess is that it won't.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @Twixes! Definitely, my apologies didn't realize I would be making many suggestions.
Co-authored-by: Paolo D'Amico <paolodamico@users.noreply.github.com>
@Twixes - is this just about good to be merged? |
It would be, but first we need to release PostHog/posthog#4263 to the public. :) These docs are false until the feature is released. |
Changes
Completely rewritten docs on organizations and projects to make them much more comprehensive.
Also, importantly, included section "Per-project permissions" – this outlines the solution to PostHog/posthog#4263 that I'm currently implementing. Feel free to suggest any change to part, as all details can still be changed.
Checklist