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

Add documentation for webactions and enhance production tracker docs #287

Merged
merged 8 commits into from
Oct 17, 2024

Conversation

MustafaJafar
Copy link
Contributor

@MustafaJafar MustafaJafar commented Oct 10, 2024

Changelog Description

resolve #252
This PR adds:

  • Details Panel doc: that explains the details panel content. main reason to add it, is to write about web actions.
  • web actions artist doc: it's added in details panel.
  • web actions admin doc: Admins can't control/customize web actions. therefore, I only added a note about web actions at the top of application addon admin doc.
  • web actions developer docs

Testing notes:

  1. Read through changes
  2. Approve they make sense to you.

@MustafaJafar MustafaJafar self-assigned this Oct 10, 2024
@MustafaJafar MustafaJafar marked this pull request as draft October 10, 2024 21:20
@MustafaJafar MustafaJafar mentioned this pull request Oct 10, 2024
5 tasks
website/docs/addon_applications_admin.md Outdated Show resolved Hide resolved
website/docs/addon_applications_admin.md Show resolved Hide resolved
website/docs/artist_details_panel.md Outdated Show resolved Hide resolved
website/docs/artist_details_panel.md Outdated Show resolved Hide resolved
website/docs/artist_details_panel.md Outdated Show resolved Hide resolved
website/docs/artist_details_panel.md Show resolved Hide resolved
website/docs/artist_details_panel.md Outdated Show resolved Hide resolved
website/docs/artist_details_panel.md Show resolved Hide resolved
website/docs/artist_details_panel.md Show resolved Hide resolved
website/docs/artist_details_panel.md Show resolved Hide resolved
@MustafaJafar MustafaJafar marked this pull request as ready for review October 11, 2024 21:50
Copy link
Member

@Innders Innders left a comment

Choose a reason for hiding this comment

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

Awesome stuff 💯

Comment on lines +387 to +388
entity_type="folder",
entity_subtypes=None,
Copy link
Contributor

Choose a reason for hiding this comment

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

I recall - as I tried to implement these - being quite confused about what combinations of values this support. Should we document that clearer somewhere (either in the code somewhere, or here?)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@martastain
TL;DR
This PR adds draft/initial docs for implementing web actions. Also, I've added an example web action.
My question: Do you have any recommendations for extending the current initial docs?

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm personally fine with it staying as is - just saying that it'd be nice to get this clarified over time because it's where I got lost.

@Innders
Copy link
Member

Innders commented Oct 17, 2024

@MustafaJafar this is never going to get approved by everyone, probably better to merge now and improve later?

@MustafaJafar
Copy link
Contributor Author

@MustafaJafar this is never going to get approved by everyone, probably better to merge now and improve later?

yeah, let's merge it.

@MustafaJafar MustafaJafar merged commit 63ec695 into main Oct 17, 2024
4 checks passed
@MustafaJafar MustafaJafar deleted the 252-add-documentation-for-webactions branch October 17, 2024 15:54
![](assets/addon_dev/web_action_example.png)

```python title="my_addon/client/my_addon/__init__.py"
from qtpy import QtWidgets
Copy link
Member

Choose a reason for hiding this comment

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

It's too late, but Qt (or any other runtime dependency) should never be imported in addon...

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 is not the only example that imports QT in addon 😅
e.g. I did the same in the tray example

For reference, should it be imported inside the function like here?

Copy link
Member

Choose a reason for hiding this comment

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

For reference, should it be imported inside the function like here?

Yes, usually by importing Qt it in the function, or by importing file that has Qt implementation inside the function.

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

Successfully merging this pull request may close these issues.

Add Documentation for webactions
4 participants