Skip to content

Commit

Permalink
TASK: Update references [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
Jenkins committed Oct 9, 2024
1 parent 41e5157 commit eb2dfab
Show file tree
Hide file tree
Showing 2 changed files with 206 additions and 36 deletions.
221 changes: 206 additions & 15 deletions Neos.Neos/Documentation/References/CommandReference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2739,20 +2739,66 @@ Options



.. _`Neos Command Reference: NEOS.NEOS neos.neos:workspace:create`:
.. _`Neos Command Reference: NEOS.NEOS neos.neos:workspace:assignrole`:

``neos.neos:workspace:create``
******************************
``neos.neos:workspace:assignrole``
**********************************

**Assign a workspace role to the given user/user group**

Without explicit workspace roles, only administrators can change the corresponding workspace.
With this command, a user or group (represented by a Flow role identifier) can be granted one of the two roles:
- collaborator: Can read from and write to the workspace
- manager: Can read from and write to the workspace and manage it (i.e. change metadata & role assignments)

Examples:

To grant editors read and write access to a (shared) workspace: *./flow workspace:assignrole some-workspace "Neos.Neos:AbstractEditor" collaborator*

To grant a specific user read, write and manage access to a workspace: *./flow workspace:assignrole some-workspace admin manager --type user*

{@see WorkspaceRole}

Arguments
^^^^^^^^^

``--workspace``
Name of the workspace, for example "some-workspace
``--subject``
The user/group that should be assigned. By default, this is expected to be a Flow role identifier (e.g. 'Neos.Neos:AbstractEditor') – if $type is 'user', this is the username (aka account identifier) of a Neos user
``--role``
Role to assign, either 'collaborator' or 'manager' – a collaborator can read and write from/to the workspace. A manager can _on top_ change the workspace metadata & roles itself



Options
^^^^^^^

``--content-repository``
Identifier of the content repository. (Default: 'default')
``--type``
Type of role, either 'group' (default) or 'user' – if 'group', $subject is expected to be a Flow role identifier, otherwise the username (aka account identifier) of a Neos user





.. _`Neos Command Reference: NEOS.NEOS neos.neos:workspace:createpersonal`:

``neos.neos:workspace:createpersonal``
**************************************

**Create a new personal workspace for the specified user**

**Create a new workspace**

This command creates a new workspace.

Arguments
^^^^^^^^^

``--workspace``
Name of the workspace, for example "christmas-campaign
``--owner``
The username (aka account identifier) of a User to own the workspace



Expand All @@ -2765,8 +2811,6 @@ Options
Human friendly title of the workspace, for example "Christmas Campaign
``--description``
A description explaining the purpose of the new workspace
``--owner``
The identifier of a User to own the workspace
``--content-repository``
Identifier of the content repository. (Default: 'default')

Expand All @@ -2779,9 +2823,9 @@ Options
``neos.neos:workspace:createroot``
**********************************

**Create a new root workspace for a content repository.**

**Create a new root workspace for a content repository**

NOTE: By default, only administrators can access workspaces without role assignments. Use *workspace:assignrole* to add workspace permissions

Arguments
^^^^^^^^^
Expand All @@ -2796,6 +2840,43 @@ Options

``--content-repository``
Identifier of the content repository. (Default: 'default')
``--title``
Optional title of the workspace
``--description``
Optional description of the workspace





.. _`Neos Command Reference: NEOS.NEOS neos.neos:workspace:createshared`:

``neos.neos:workspace:createshared``
************************************

**Create a new shared workspace**

NOTE: By default, only administrators can access workspaces without role assignments. Use *workspace:assignrole* to add workspace permissions

Arguments
^^^^^^^^^

``--workspace``
Name of the workspace, for example "christmas-campaign



Options
^^^^^^^

``--base-workspace``
Name of the base workspace. If none is specified, "live" is assumed.
``--title``
Human friendly title of the workspace, for example "Christmas Campaign
``--description``
A description explaining the purpose of the new workspace
``--content-repository``
Identifier of the content repository. (Default: 'default')



Expand Down Expand Up @@ -2829,12 +2910,6 @@ Options



Related commands
^^^^^^^^^^^^^^^^

``neos.neos:workspace:discard``
Discard changes in workspace



.. _`Neos Command Reference: NEOS.NEOS neos.neos:workspace:discard`:
Expand Down Expand Up @@ -2964,6 +3039,122 @@ Options



.. _`Neos Command Reference: NEOS.NEOS neos.neos:workspace:setdescription`:

``neos.neos:workspace:setdescription``
**************************************

**Set/change the description of a workspace**



Arguments
^^^^^^^^^

``--workspace``
Name of the workspace, for example "some-workspace
``--new-description``
Human friendly description of the workspace



Options
^^^^^^^

``--content-repository``
Identifier of the content repository. (Default: 'default')





.. _`Neos Command Reference: NEOS.NEOS neos.neos:workspace:settitle`:

``neos.neos:workspace:settitle``
********************************

**Set/change the title of a workspace**



Arguments
^^^^^^^^^

``--workspace``
Name of the workspace, for example "some-workspace
``--new-title``
Human friendly title of the workspace, for example "Some workspace



Options
^^^^^^^

``--content-repository``
Identifier of the content repository. (Default: 'default')





.. _`Neos Command Reference: NEOS.NEOS neos.neos:workspace:show`:

``neos.neos:workspace:show``
****************************

**Display details for the specified workspace**



Arguments
^^^^^^^^^

``--workspace``
Name of the workspace to show



Options
^^^^^^^

``--content-repository``
The name of the content repository. (Default: 'default')





.. _`Neos Command Reference: NEOS.NEOS neos.neos:workspace:unassignrole`:

``neos.neos:workspace:unassignrole``
************************************

**Unassign a workspace role from the given user/user group**



Arguments
^^^^^^^^^

``--workspace``
Name of the workspace, for example "some-workspace
``--subject``
The user/group that should be unassigned. By default, this is expected to be a Flow role identifier (e.g. 'Neos.Neos:AbstractEditor') – if $type is 'user', this is the username (aka account identifier) of a Neos user



Options
^^^^^^^

``--content-repository``
Identifier of the content repository. (Default: 'default')
``--type``
Type of role, either 'group' (default) or 'user' – if 'group', $subject is expected to be a Flow role identifier, otherwise the username (aka account identifier) of a Neos user





.. _`Neos Command Reference: NEOS.SITEKICKSTARTER`:

Package *NEOS.SITEKICKSTARTER*
Expand Down
21 changes: 0 additions & 21 deletions Neos.Neos/Documentation/References/ViewHelpers/Neos.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,27 +26,6 @@ Arguments



.. _`Neos ViewHelper Reference: neos:backend.changeStats`:

neos:backend.changeStats
------------------------

Displays a text-based "bar graph" giving an indication of the amount and type of
changes done to something. Created for use in workspace management.

:Implementation: Neos\\Neos\\ViewHelpers\\Backend\\ChangeStatsViewHelper




Arguments
*********

* ``changeCounts`` (array): Expected keys: new, changed, removed




.. _`Neos ViewHelper Reference: neos:backend.colorOfString`:

neos:backend.colorOfString
Expand Down

0 comments on commit eb2dfab

Please sign in to comment.