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

Rewrite docs on organizations and projects, with per-project permissions #1948

Merged
merged 15 commits into from
Sep 30, 2021

Conversation

Twixes
Copy link
Contributor

@Twixes Twixes commented Sep 9, 2021

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

Copy link
Contributor

@paolodamico paolodamico left a 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)

contents/docs/user-guides/organizations-and-projects.md Outdated Show resolved Hide resolved
contents/docs/user-guides/organizations-and-projects.md Outdated Show resolved Hide resolved
@Twixes
Copy link
Contributor Author

Twixes commented Sep 9, 2021

Good points, addressed @paolodamico

@Twixes Twixes marked this pull request as draft September 9, 2021 18:10
Copy link
Contributor

@leggetter leggetter left a 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

contents/docs/user-guides/organizations-and-projects.md Outdated Show resolved Hide resolved
contents/docs/user-guides/organizations-and-projects.md Outdated Show resolved Hide resolved
contents/docs/user-guides/organizations-and-projects.md Outdated Show resolved Hide resolved
contents/docs/user-guides/organizations-and-projects.md Outdated Show resolved Hide resolved
contents/docs/user-guides/organizations-and-projects.md Outdated Show resolved Hide resolved
contents/docs/user-guides/organizations-and-projects.md Outdated Show resolved Hide resolved
contents/docs/user-guides/organizations-and-projects.md Outdated Show resolved Hide resolved
contents/docs/user-guides/organizations-and-projects.md Outdated Show resolved Hide resolved
contents/docs/user-guides/organizations-and-projects.md Outdated Show resolved Hide resolved
@Twixes
Copy link
Contributor Author

Twixes commented Sep 10, 2021

Good points @leggetter, I'm not sure about capitalizing these words here though.
The idea has some merit to me, as they're sort of distinct concepts, but I think this should be clearly explained in the style guide if we want to do this, because there's more concepts like this, and there are some edge cases. For instance, should it be "Organization invite" or "Organization Invite". Also, since there's access level "Member" I use lower-case "member" as "any organization member" and "Member" as "Member-level organization member", which would be lost if we capitalized that noun too.
So I'd rather do that in another PR.

Twixes and others added 2 commits September 10, 2021 11:28
Co-authored-by: Phil Leggetter <phil@leggetter.co.uk>
Copy link
Contributor

@paolodamico paolodamico left a 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!

contents/docs/user-guides/organizations-and-projects.md Outdated Show resolved Hide resolved
contents/docs/user-guides/organizations-and-projects.md Outdated Show resolved Hide resolved
contents/docs/user-guides/organizations-and-projects.md Outdated Show resolved Hide resolved
contents/docs/user-guides/organizations-and-projects.md Outdated Show resolved Hide resolved
contents/docs/user-guides/organizations-and-projects.md Outdated Show resolved Hide resolved
contents/docs/user-guides/organizations-and-projects.md Outdated Show resolved Hide resolved
contents/docs/user-guides/organizations-and-projects.md Outdated Show resolved Hide resolved
contents/docs/user-guides/organizations-and-projects.md Outdated Show resolved Hide resolved
contents/docs/user-guides/organizations-and-projects.md Outdated Show resolved Hide resolved
Twixes and others added 2 commits September 22, 2021 11:33
Co-authored-by: Paolo D'Amico <paolodamico@users.noreply.github.com>
@Twixes Twixes added the docs Improvements or additions to product documentation, "Docs" label Sep 22, 2021
@Twixes
Copy link
Contributor Author

Twixes commented Sep 22, 2021

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).
Copy link
Contributor

@paolodamico paolodamico Sep 22, 2021

Choose a reason for hiding this comment

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

Suggested change
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

Copy link
Contributor Author

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.

Copy link
Contributor

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.

Copy link
Contributor

@paolodamico paolodamico left a 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>
@leggetter
Copy link
Contributor

@Twixes - is this just about good to be merged?

@Twixes
Copy link
Contributor Author

Twixes commented Sep 24, 2021

It would be, but first we need to release PostHog/posthog#4263 to the public. :) These docs are false until the feature is released.

@Twixes Twixes marked this pull request as ready for review September 30, 2021 01:01
@Twixes Twixes merged commit bca74b1 into master Sep 30, 2021
@Twixes Twixes deleted the permissioning-plus branch September 30, 2021 09:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to product documentation, "Docs"
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants