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

Show module "Information" links in the "Module administration" page #6848

Open
marc-farre opened this issue Feb 8, 2024 · 6 comments
Open

Comments

@marc-farre
Copy link
Collaborator

marc-farre commented Feb 8, 2024

Is your feature request related to a problem? Please describe.

For some modules, the README.md file gives important information about the module.

Now that modules are managed in 2 different pages, we should give the possibility, for users allowed to manage settings but not modules, to view the README content of the modules.

But currently, it's not possible, because you need to first click on "Show on Marketplace":

image

3 problems with this:

Describe the solution you'd like

Add the “Information” menu entry in the "Module administration" page:

image

@marc-farre
Copy link
Collaborator Author

@luke- if you agree with this suggestion, I can send a PR

@ArchBlood
Copy link
Contributor

@luke- if you agree with this suggestion, I can send a PR

In this case, I believe instead of opening in a new window (i.e. opening the direct link to the marketplace) I think we should do like we use to and open in a modal to reduce redirections.

@luke-
Copy link
Contributor

luke- commented Feb 8, 2024

Hmmm, there are two reasons for the strong separation between "Module Administration" and "Marketplace".

  • The Marketplace is slower because API requests have to load the information first
  • Some installations do not have an activated Marketplace

For the number of pending available modules updates, we have implemented a solution via the CronJob.

We have intentionally removed the display of README.md:

  • The installation of this module is only possible manually. e.g. SFTP - i.e. rather technically experienced users installs custom modules
  • The previous simple display of README.md was very limited. (e.g. without images or further Markdown Docs e.g. Manual)
  • We always try to direct users to our Marketplace website, where the most up-to-date and comprehensive information is always available.

But I also understand your points and see potential for improvement here. However, I'm not yet sure exactly how :-)

@marc-farre
Copy link
Collaborator Author

Just to specify, it's not only for custom modules.

Let's say, e.g, you install and activate the "Mass user import". The setup instructions are in the README file.

I think we need an easy way to read these instructions, without having to go to the marketplace.

Alternatively, we could have a button widget in HumHub core that we could use in the view of the module configuration page.

E.g.
image

@luke-
Copy link
Contributor

luke- commented Feb 9, 2024

Hmm, in these cases I would simply hard link the information pages in the module configuration. The URL should not actually change. https://marketplace.humhub.com/module/rest/manual

For custom modules, I wouldn't actually provide a separate "Docs" viewer in HumHub for the time being.

But for marketplace modules we should definitely improve the path to further information.

image
image

@Eladnarlea
Copy link

this has been taken into account when designing and enhancing the look of the cards overall and especially in the marketplace.

@luke- https://www.figma.com/file/tshvUVBzxy7uW8eZs6n6IG/HumHub---Design-System?type=design&node-id=4294-2006&mode=dev

https://github.com/humhub/design-tasks-overall/issues/18

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants