prepare version 2.0.0 #17

Slashek · 2024-10-13T10:27:37Z

No description provided.

simplykatsa · 2024-10-14T06:48:58Z

README.md

+
+### Setup
+
+1. First, install the module using the [pos-cli](https://github.com/Platform-OS/pos-cli).


This steps looks like a duplication, as the previous ### Installation Steps section walks you through the installation.

simplykatsa · 2024-10-14T06:51:10Z

README.md

+
+### Setup
+
+1. First, install the module using the [pos-cli](https://github.com/Platform-OS/pos-cli).


Suggested change

1. First, install the module using the [pos-cli](https://github.com/Platform-OS/pos-cli).

1. First, install the module using the [pos-cli](https://github.com/Platform-OS/pos-cli) if you haven't done so already.

simplykatsa · 2024-10-14T06:53:08Z

README.md

+  - modules/components
+```
+
+3. Configure  [app/user.yml](https://documentation.platformos.com/developer-guide/users/user#adding-properties-to-the-user) file:


Suggested change

3. Configure [app/user.yml](https://documentation.platformos.com/developer-guide/users/user#adding-properties-to-the-user) file:

3. **Update the user configuration** in the [app/user.yml](https://documentation.platformos.com/developer-guide/users/user#adding-properties-to-the-user) file:

simplykatsa · 2024-10-14T06:55:11Z

README.md

+
+```
+
+4. Overwrite user's module permission file and add [admin_pages.view](https://github.com/Platform-OS/pos-module-admin/blob/master/modules/admin/public/views/pages/admin/index.liquid#L18) (and [admin.users.manage](https://github.com/Platform-OS/pos-module-user/blob/master/modules/user/public/lib/hooks/hook_admin_page.liquid) to access [manage users admin page defined in the user module](https://github.com/Platform-OS/pos-module-user/blob/master/modules/user/public/views/partials/admin_pages/list.liquid)) to the admin role. The links point to the implementation, which should allow you to understand how everything is wired together. Example permissions file:


Suggested change

4. Overwrite user's module permission file and add [admin_pages.view](https://github.com/Platform-OS/pos-module-admin/blob/master/modules/admin/public/views/pages/admin/index.liquid#L18) (and [admin.users.manage](https://github.com/Platform-OS/pos-module-user/blob/master/modules/user/public/lib/hooks/hook_admin_page.liquid) to access [manage users admin page defined in the user module](https://github.com/Platform-OS/pos-module-user/blob/master/modules/user/public/views/partials/admin_pages/list.liquid)) to the admin role. The links point to the implementation, which should allow you to understand how everything is wired together. Example permissions file:

4. Overwrite the user's module permission file and add the permissions for [admin_pages.view](https://github.com/Platform-OS/pos-module-admin/blob/master/modules/admin/public/views/pages/admin/index.liquid#L18) and [admin.users.manage](https://github.com/Platform-OS/pos-module-user/blob/master/modules/user/public/lib/hooks/hook_admin_page.liquid) to access the [manage users admin page defined in the user module](https://github.com/Platform-OS/pos-module-user/blob/master/modules/user/public/views/partials/admin_pages/list.liquid) to the admin role. The links point to the implementation, which should help you understand how everything is wired together. Here is an example permissions file:

simplykatsa · 2024-10-14T06:57:00Z

README.md

+{% return data %}
+```
+
+5. Add `admin` role to the user you would like to make admin (or add [`superadmin` role to ensure they have access to everything, always).


Suggested change

5. Add `admin` role to the user you would like to make admin (or add [`superadmin` role to ensure they have access to everything, always).

5. **Assign the `admin` role** to the user you want to grant admin access to, or add the `superadmin` role for full access.

simplykatsa · 2024-10-14T07:38:52Z

README.md

+
+If you want an admin page (or just a link) to show up in the admin navigation and the admin UI, you can implement `lib/hooks/hook_admin_page.liquid`. 
+
 It should return an array of objects describing the page and/or navigation items:


Suggested change

It should return an array of objects describing the page and/or navigation items:

This function should return an array of objects describing the page and/or navigation items:

simplykatsa · 2024-10-14T07:39:46Z

README.md


 ### hook_admin_layout
+
 You can register your own admin layout file to provide a custom admin experience in your app.


Suggested change

You can register your own admin layout file to provide a custom admin experience in your app.

You can register your own admin layout file to customize the admin experience in your app.

simplykatsa · 2024-10-14T07:41:13Z

README.md

+
 You can register your own admin layout file to provide a custom admin experience in your app.
+
 This is how the [Theme Manager Module](https://github.com/Platform-OS/pos-module-theme-manager) implements admin themes, by looking for available admin theme implementations and registering the admin layout from the currently selected active theme.


Suggested change

This is how the [Theme Manager Module](https://github.com/Platform-OS/pos-module-theme-manager) implements admin themes, by looking for available admin theme implementations and registering the admin layout from the currently selected active theme.

The [Theme Manager Module](https://github.com/Platform-OS/pos-module-theme-manager) implements admin themes by searching for available admin theme implementations and registering the admin layout from the currently selected active theme.

simplykatsa · 2024-10-14T07:41:37Z

README.md

 This is how the [Theme Manager Module](https://github.com/Platform-OS/pos-module-theme-manager) implements admin themes, by looking for available admin theme implementations and registering the admin layout from the currently selected active theme.
-The `admin_layou` hook simply returns the path of a liquid partial as a string.
+
+The `admin_layout` hook simply returns the path of a liquid partial as a string. Example `lib/hooks/admin_layout_hook.liquid`:


Suggested change

The `admin_layout` hook simply returns the path of a liquid partial as a string. Example `lib/hooks/admin_layout_hook.liquid`:

The `admin_layout` hook returns the path of a liquid partial as a string. For example, in `lib/hooks/admin_layout_hook.liquid`:

simplykatsa · 2024-10-14T07:41:54Z

README.md

+{% return 'admin_layout' %}
+```
+
+Which will load `app/views/partials/admin_layout.liquid`.


Suggested change

Which will load `app/views/partials/admin_layout.liquid`.

This command loads `app/views/partials/admin_layout.liquid`.

prepare version 2.0.0

e14c48f

simplykatsa reviewed Oct 14, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

prepare version 2.0.0 #17

prepare version 2.0.0 #17

Uh oh!

Slashek commented Oct 13, 2024

Uh oh!

simplykatsa Oct 14, 2024

Uh oh!

simplykatsa Oct 14, 2024

Uh oh!

simplykatsa Oct 14, 2024

Uh oh!

simplykatsa Oct 14, 2024

Uh oh!

simplykatsa Oct 14, 2024

Uh oh!

simplykatsa Oct 14, 2024

Uh oh!

simplykatsa Oct 14, 2024

Uh oh!

simplykatsa Oct 14, 2024

Uh oh!

simplykatsa Oct 14, 2024

Uh oh!

simplykatsa Oct 14, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants


		### Setup

		1. First, install the module using the [pos-cli](https://github.com/Platform-OS/pos-cli).

	3. Configure [app/user.yml](https://documentation.platformos.com/developer-guide/users/user#adding-properties-to-the-user) file:
	3. Update the user configuration in the [app/user.yml](https://documentation.platformos.com/developer-guide/users/user#adding-properties-to-the-user) file:


		```

		4. Overwrite user's module permission file and add [admin_pages.view](https://github.com/Platform-OS/pos-module-admin/blob/master/modules/admin/public/views/pages/admin/index.liquid#L18) (and [admin.users.manage](https://github.com/Platform-OS/pos-module-user/blob/master/modules/user/public/lib/hooks/hook_admin_page.liquid) to access [manage users admin page defined in the user module](https://github.com/Platform-OS/pos-module-user/blob/master/modules/user/public/views/partials/admin_pages/list.liquid)) to the admin role. The links point to the implementation, which should allow you to understand how everything is wired together. Example permissions file:

	5. Add `admin` role to the user you would like to make admin (or add [`superadmin` role to ensure they have access to everything, always).
	5. Assign the `admin` role to the user you want to grant admin access to, or add the `superadmin` role for full access.


		If you want an admin page (or just a link) to show up in the admin navigation and the admin UI, you can implement `lib/hooks/hook_admin_page.liquid`.

		It should return an array of objects describing the page and/or navigation items:

	It should return an array of objects describing the page and/or navigation items:
	This function should return an array of objects describing the page and/or navigation items:


		### hook_admin_layout

		You can register your own admin layout file to provide a custom admin experience in your app.


		You can register your own admin layout file to provide a custom admin experience in your app.

		This is how the [Theme Manager Module](https://github.com/Platform-OS/pos-module-theme-manager) implements admin themes, by looking for available admin theme implementations and registering the admin layout from the currently selected active theme.

	This is how the [Theme Manager Module](https://github.com/Platform-OS/pos-module-theme-manager) implements admin themes, by looking for available admin theme implementations and registering the admin layout from the currently selected active theme.
	The [Theme Manager Module](https://github.com/Platform-OS/pos-module-theme-manager) implements admin themes by searching for available admin theme implementations and registering the admin layout from the currently selected active theme.

	The `admin_layout` hook simply returns the path of a liquid partial as a string. Example `lib/hooks/admin_layout_hook.liquid`:
	The `admin_layout` hook returns the path of a liquid partial as a string. For example, in `lib/hooks/admin_layout_hook.liquid`:

	Which will load `app/views/partials/admin_layout.liquid`.
	This command loads `app/views/partials/admin_layout.liquid`.

prepare version 2.0.0 #17

Are you sure you want to change the base?

prepare version 2.0.0 #17

Uh oh!

Conversation

Slashek commented Oct 13, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants