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

Docs: Access control documentation reworked 2.5 #5723

Open
wants to merge 23 commits into
base: main
Choose a base branch
from

Conversation

comradekingu
Copy link
Contributor

@comradekingu comradekingu commented Mar 22, 2021

to automate inclusion of all languages or projects.

into where?

Delete existing translations [`Administr

Single strings or entire translations at once?

Add several languages for translation [`Administration

Why "several" is it bulk-addition as opposed to clicking through one-by one in the user UI?

This role ensures all users visibility of public projects.
By default, all users are members of this group.

How is a role a group? Need to get all the cursory logic established up top. (and then note to self read through with that understanding (that I don't have)).

Managers
Group for administrators.

Is it "superusers", (which I seem to think is what I call "site-wide administrators")
The whole "manage/rs", "objects". It is all a bit much all at once.

Administration
Includes all permissions available for the project.
All available permissions for the project.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Including adding people that can add administrators?
Should this be site-wide administration? What I am asking is if "superuser" is above this?

Copy link
Member

Choose a reason for hiding this comment

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

This is only at project level - it grants all permissions for the project.


Languages
Can manage translated languages (add or remove translations).
Manage translated languages (add or remove translations).
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Individual strings or entire languages?

By default this prevents Weblate from granting access provided by
`Users` and `Viewers` :ref:`default groups <default-groups>` due to these groups’
own configuration. This doesn’t prevent you from granting permissions to those
projects site-wide by altering default groups, creating a new one, or creating
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Note to self: wasn't this already not possible?

groups. For example, you may want to give a permission to manage screenshots to all
the `Users`.
Additional permissions can be granted to the default
groups. In this example the ability manage screenshots for all `Users`.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Example needed

by site-wide or per-project groups by adding another custom group.
Dedicated groups to manage permissions for languages, components, and projects
can be created. These groups can only grant additional privileges that can not
revoke any permission granted by site-wide or per-project groups by adding another
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Granted which permissions, to whom, for what entity?

@@ -4,32 +4,32 @@ Access control
==============

Weblate comes with a fine-grained privilege system to assign user permissions
for the whole instance, or in a limited scope.
for the whole instance with predefined roles, or by assigning one or more
groups of permissions to users for everything, or individual projects, components,
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This needs to be a cursory overview.
Otherwise the whole thing is a riddle where the reader has to establish the connections.
Suggestions welcome :)

@codecov
Copy link

codecov bot commented Mar 23, 2021

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (6aee586) 90.82% compared to head (0f6ff75) 90.78%.
Report is 275 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #5723      +/-   ##
==========================================
- Coverage   90.82%   90.78%   -0.04%     
==========================================
  Files         554      559       +5     
  Lines       57306    57534     +228     
  Branches     9122     9180      +58     
==========================================
+ Hits        52046    52235     +189     
- Misses       3640     3670      +30     
- Partials     1620     1629       +9     

see 51 files with indirect coverage changes

docs/admin/access.rst Outdated Show resolved Hide resolved
@nijel nijel requested a review from a team March 23, 2021 06:16
Base automatically changed from master to main March 23, 2021 12:16
docs/admin/access.rst Outdated Show resolved Hide resolved
docs/admin/access.rst Outdated Show resolved Hide resolved
@github-actions
Copy link

github-actions bot commented May 3, 2021

This pull request has been automatically marked as stale because there wasn’t any recent activity.

It will be closed soon if no further action occurs.

Thank you for your contributions!

@github-actions github-actions bot added the wontfix Nobody will work on this. label May 3, 2021
- Otherwise, adding any :guilabel:`Projects` to a group (either by directly
listing them or by having :guilabel:`Selected projects` set to :guilabel:`All
public`) grants the group permissions for the projects. (Effectively
the same permissions as being granted access to :ref:`unrestricted components <component-restricted>`
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Didn't look into what "which effectively grants the same permissions to access all projects" from the merge error means. Otherwise rewritten from what it was.

@comradekingu
Copy link
Contributor Author

comradekingu commented May 3, 2021

Neverstale

@github-actions github-actions bot removed the wontfix Nobody will work on this. label May 4, 2021
@github-actions
Copy link

This pull request has been automatically marked as stale because there wasn’t any recent activity.

It will be closed soon if no further action occurs.

Thank you for your contributions!

@github-actions github-actions bot added the wontfix Nobody will work on this. label Jun 25, 2021
@nijel nijel removed the wontfix Nobody will work on this. label Jun 29, 2021
@github-actions github-actions bot removed the wontfix Nobody will work on this. label Jan 22, 2024
@Justman100
Copy link

What here now?

@nijel
Copy link
Member

nijel commented Feb 19, 2024

@Justman100 Somebody needs to review this to verify it doesn't change the meaning of the documentation what has happened in the past. The typical reason for that is that the original documentation isn't clear enough and when reworking, another meaning is chosen than was originally intended.

That's why several of these “reworked documentation” pull requests are stuck. These are big, what makes them challenging to review at once and GitHub is not really helpful in doing iterative review/merge.

@@ -63,20 +65,18 @@ project.

.. image:: /screenshots/project-access.webp

The default value can be changed by :setting:`DEFAULT_ACCESS_CONTROL`.
Access mode can also be changed by setting :setting:`DEFAULT_ACCESS_CONTROL`.
Copy link
Member

Choose a reason for hiding this comment

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

This only changes the default value for newly created projects.

Your project name and other information can’t be revealed through this.
`Private` projects still expose counts for all projects in their
respective statistics and language summary.
This does not reveal project name or other info.
Copy link
Member

Choose a reason for hiding this comment

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

This makes it IMHO less clear. The intention is to make clear that even private projects are reflected in site-wide statistics, such as global or language ones.

@@ -97,47 +97,57 @@ The following teams are automatically created for every project:

For `Public`, `Protected` and `Private` projects:

Granting users :guilabel:`Manage project access` (see :ref:`privileges`)
gives them access to assign other users in Public`, `Protected` and
`Private` (but not `Custom`) projects to one of the following groups:
Copy link
Member

Choose a reason for hiding this comment

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

This is duplicated few lines above.

docs/admin/access.rst Outdated Show resolved Hide resolved
@Justman100
Copy link

@comradekingu


The following teams are automatically created for every project:
Granting users :guilabel:`Manage project access` (see :ref:`privileges`)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I would argue it doesn't need to be pointed out that users need to have MPA to do what is explained to be recursive about MPA.
My original intent must have been to replace the duplicated text, and then I didn't remove the original one.
Maybe it makes sense now, but not at all sure.

Some of the text is moved to a hint below.

docs/admin/access.rst Outdated Show resolved Hide resolved
Co-authored-by: Allan Nordhøy <epost@anotheragency.no>
Copy link

This pull request has been automatically marked as stale because there wasn’t any recent activity.

It will be closed soon if no further action occurs.

Thank you for your contributions!

@github-actions github-actions bot added the wontfix Nobody will work on this. label Mar 25, 2024
@Justman100
Copy link

@comradekingu

What here now?

@orangesunny orangesunny removed the wontfix Nobody will work on this. label Mar 25, 2024
@orangesunny
Copy link
Member

What here now?

A review is needed. @comradekingu did his work, now I need to find time to go through it. As the PR is long with many changes, I needed to postpone it multiple times. Short PRs get merged quicker.

docs/admin/access.rst Outdated Show resolved Hide resolved
docs/admin/access.rst Outdated Show resolved Hide resolved
Copy link

This pull request has been automatically marked as stale because there wasn’t any recent activity.

It will be closed soon if no further action occurs.

Thank you for your contributions!

@github-actions github-actions bot added the wontfix Nobody will work on this. label Apr 25, 2024
@orangesunny orangesunny removed the wontfix Nobody will work on this. label Apr 25, 2024
@Justman100
Copy link

@nijel @comradekingu

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

Successfully merging this pull request may close these issues.

None yet

4 participants