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] field_service: create new page about worksheet #9795

Closed
wants to merge 1 commit into from

Conversation

guga-odoo
Copy link

@guga-odoo guga-odoo commented Jun 13, 2024

Task-3991994

@robodoo
Copy link
Collaborator

robodoo commented Jun 13, 2024

Pull request status dashboard

@guga-odoo guga-odoo marked this pull request as ready for review June 18, 2024 12:38
@guga-odoo guga-odoo requested a review from a team June 18, 2024 12:39
@C3POdoo C3POdoo requested a review from a team June 18, 2024 12:43
Copy link
Contributor

@auva-odoo auva-odoo left a comment

Choose a reason for hiding this comment

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

This is a super thorough and well-researched doc content-wise! I’ve added a few comments and suggestions to improve the formatting and structure a bit. I also recommend simplifying a few sentences to make them more direct. A few general comments (that are also included in the review):

  • Use sentence case in titles
  • If it's a UI element, it needs guilabel

I know it seems like a lot of comments, but please believe me when I say you did a really good job here! We can sit down together to discuss it if you’d like, or you can review my comments and get back to me with any questions. Please don't hesitate to reach out if you need anything! Thanks 🙂

content/applications/services/field_service/worksheets.rst Outdated Show resolved Hide resolved
content/applications/services/field_service/worksheets.rst Outdated Show resolved Hide resolved
content/applications/services/field_service/worksheets.rst Outdated Show resolved Hide resolved
content/applications/services/field_service/worksheets.rst Outdated Show resolved Hide resolved
content/applications/services/field_service/worksheets.rst Outdated Show resolved Hide resolved
Comment on lines 45 to 50
Assign a default Worksheet Template
===================================

If you have configured multiple Worksheet Templates, you can select one to be set up by
default when you create a new Field Service task. Go to your task, drag your mouse over the name of
your project to make the green arrow and the **internal link** tab appear, click on it.
Copy link
Contributor

@auva-odoo auva-odoo Jun 21, 2024

Choose a reason for hiding this comment

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

I don't think the title is necessary here and it looks a little odd with just 1 line udner the previous one. Instead, I would maybe do something like this to 1) introduce the concept of a default template (which was done in the title) and 2) be a little more direct:

Suggested change
Assign a default Worksheet Template
===================================
If you have configured multiple Worksheet Templates, you can select one to be set up by
default when you create a new Field Service task. Go to your task, drag your mouse over the name of
your project to make the green arrow and the **internal link** tab appear, click on it.
By default, the :guilabel:`Default worksheet` template is selected. To define another default worksheet template,
click the :guilabel:`` (:guilabel:`Internal link`) icon that appears when you hover your mouse over the :guilabel:`Project` field on the task form.

see this doc for how to add icons directly into the text like I did in my suggestion https://www.odoo.com/documentation/master/contributing/documentation/rst_cheat_sheet.html#icons

Copy link
Author

Choose a reason for hiding this comment

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

Thank you for this tip!

content/applications/services/field_service/worksheets.rst Outdated Show resolved Hide resolved
content/applications/services/field_service/worksheets.rst Outdated Show resolved Hide resolved
Comment on lines 69 to 72
- As soon as you save a worksheet, the appearance of the **Worksheet** smart button on
your task will change and display **Worksheet Complete** instead, regardless some fields are
left blank.
- Any field set up as **required** has to be filled for a worksheet to be saved.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- As soon as you save a worksheet, the appearance of the **Worksheet** smart button on
your task will change and display **Worksheet Complete** instead, regardless some fields are
left blank.
- Any field set up as **required** has to be filled for a worksheet to be saved.
- As soon as you save a worksheet, the appearance of the :guilabel:`Worksheet` smart button on
the task changes to :guilabel:`Worksheet Complete` instead, even if some fields are
left blank.
- Any field defined as :guilabel:`Required` has to be filled for a worksheet to be saved.
  • these are all UI elements and should therefore be guilabel (+ Required with a capital R)
  • regardless needs "of" afterwards so the sentence would be "regardless of some fields being left blank", which is very heavy IMO

Copy link
Contributor

@auva-odoo auva-odoo left a comment

Choose a reason for hiding this comment

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

Hi @guga-odoo let me know when you have time to do this second round together 🙂

Copy link
Contributor

@auva-odoo auva-odoo left a comment

Choose a reason for hiding this comment

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

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

Successfully merging this pull request may close these issues.

3 participants