[IMP] helpdesk: combine and update invoice time docs #3974

jero-odoo · 2023-03-31T13:26:21Z

This PR combines the two "Invoice time spent on tickets" docs into one document, called "Track and Bill Time". It also updates the process for 16 including screenshots and terminology, and removes unnecessary steps.
I also reorganized the document structure with this update. The two previous documents were under a different sub-section "Timesheet and Invoice". That sub-section been removed, and the new document is now listed under "Advanced". Redirects have been updated.

robodoo · 2023-03-31T13:26:38Z

Pull request status dashboard.

ksc-odoo

Hey @jero-odoo - just finished my Peer Review on this doc - Great Job! If you have any questions about anything, don't hesitate to reach out. Thanks!

content/applications/services/helpdesk/advanced/track_and_bill.rst

samueljlieber · 2023-04-18T19:35:34Z

Fixed merge conflict in 9430a54

content/applications/services/helpdesk/advanced/track_and_bill.rst

jero-odoo · 2023-04-19T19:01:22Z

Thank you @ksc-odoo!
@samueljlieber can you do a technical review of this doc when you have a chance? Thank you!

samueljlieber

Hi @jero-odoo 👋 I had only a few small changes from my technical review. I will push these changes up in a commit after this review. Please read through my suggestions and let me know if you approve and I will set this PR for final review.

Thank you 🙂

samueljlieber · 2023-04-20T20:17:11Z

content/applications/services/helpdesk/advanced/track_and_bill.rst

+has even begun.
+
+.. warning::
+   Since the :guilabel:`Track & Bill Time` features require integration with other applications,


I believe we should italicize Track & Bill Time here rather than a :guilabel:

samueljlieber · 2023-04-20T20:17:40Z

content/applications/services/helpdesk/advanced/track_and_bill.rst

+   Installing a new application on a *One-App-Free* database triggers a 15-day trial. At the
+   end of the trial, if a paid subscription has not been added to the database, it will no longer
+   be active or accessible.


Lines in this paragraph can be broken later

samueljlieber · 2023-04-20T20:18:54Z

content/applications/services/helpdesk/advanced/track_and_bill.rst

+On the team's settings page, scroll to the :guilabel:`Track & Bill Time` section. Check the boxes
+labeled :guilabel:`Timesheets` and :guilabel:`Time Billing`.
+
+Checking the box for :guilabel:`Timesheets` causes a new field to appear, labeled *Project*.


we will apply a :guilabel: to Project here because it's appearance is part of the active instruction

samueljlieber · 2023-04-20T20:19:53Z

content/applications/services/helpdesk/advanced/track_and_bill.rst

+
+Checking the box for :guilabel:`Timesheets` causes a new field to appear, labeled *Project*.
+
+This project selected in this field is where all the timesheets for this team's tickets will be


Grammar: This project... ➡️ The project...

samueljlieber · 2023-04-20T20:23:53Z

content/applications/services/helpdesk/advanced/track_and_bill.rst

+
+When the :guilabel:`Time Billing` feature is enabled, a new product is created in the *Sales* app
+called :guilabel:`Service on Timesheets`. This product can be found under :menuselection:`Sales -->
+Products --> Products`. Search for `Service on Timesheets` in the :guilabel:`Search bar`. This is


let's lowercase :guilabel:search bar

samueljlieber · 2023-04-20T20:38:11Z

content/applications/services/helpdesk/advanced/track_and_bill.rst

+As new lines are added to *Timesheets* tab, the *Remaining Hours on SO* field is automatically
+updated.


We will make these :guilabel: s since they are part of the active instruction

samueljlieber · 2023-04-20T20:38:37Z

content/applications/services/helpdesk/advanced/track_and_bill.rst

+   If the number of hours on the :guilabel:`Timesheets` tab goes over the number of hours sold, the
+   :guilabel:`Remaining Hours of SO` will turn red.


These will be italicized because they are not part of the active instruction

samueljlieber · 2023-04-20T20:38:50Z

content/applications/services/helpdesk/advanced/track_and_bill.rst

+   If the number of hours on the :guilabel:`Timesheets` tab goes over the number of hours sold, the
+   :guilabel:`Remaining Hours of SO` will turn red.
+
+As hours are added to the *Timesheets* tab, they are automatically updated in the *Delivered* field


:guilabel:Timesheets tab & :guilabel:Delivered field

samueljlieber · 2023-04-20T20:39:55Z

content/applications/services/helpdesk/advanced/track_and_bill.rst

+
+Fill out the :guilabel:`Quotation` with the :guilabel:`Customer` information.
+
+On the *Order Lines* tab, click :guilabel:`Add a Product`. Select the post-paid services


:guilabel:Order Lines tab

samueljlieber · 2023-04-20T20:40:46Z

content/applications/services/helpdesk/advanced/track_and_bill.rst

+then be sent to the customer for payment.
+
+.. seealso::
+   - :doc:`/applications/inventory_and_mrp/inventory/management/products/uom`


No need to include a bullet on a single link in a ..seealso::

jero-odoo · 2023-04-21T12:39:01Z

thank you @samueljlieber , these all look good 👍

samueljlieber · 2023-04-21T13:14:32Z

Hi @StraubCreative this PR is ready for your final review 🙂

jcs-odoo

About the structure (and redirections, in this case):

I can create a linked PR in odoo/enterprise to update the doc links in the settings, but the two pages used to be targeted by different settings. Is it okay to merge these two? Maybe check with the PO. (see comment in the diff)

jcs-odoo · 2023-05-03T15:12:38Z

redirects/16.0.txt

+# applications/services
+
+applications/services/helpdesk/timesheet_and_invoice/reinvoice_from_project.rst applications/services/helpdesk/advanced/track_and_bill.rst
+applications/services/helpdesk/timesheet_and_invoice/invoice_time.rst applications/services/helpdesk/advanced/track_and_bill.rst


requires an update of the links in the settings
There are two settings that linked to these pages separately. Is it okay to update them both to a single link?

https://github.com/odoo/enterprise/blob/a342fcb0e08aaeb46a6b50f11d9834bf394b1370/helpdesk/views/helpdesk_team_views.xml#L207

https://github.com/odoo/enterprise/blob/a342fcb0e08aaeb46a6b50f11d9834bf394b1370/helpdesk/views/helpdesk_team_views.xml#L224

Hi @jcs-odoo -They are two processes that involve many of the same setup and features but differ when it comes to whether or not the customer is billed before or after the services are completed.

I confirmed with the PO (AJU) that we could combine these two. She agrees that having only one document will make it easier to send to users and to link to in the settings

Perfect :) Can you remind me, after this PR is merged, that I need to update the links in Odoo? Thanks!

@jcs-odoo Will do! Thank you!

StraubCreative

@samueljlieber take another look please

samueljlieber

Hi @jero-odoo 👋 I have a handful of technical changes on this PR after taking another look. Please see my suggestions below and let me know if you have any questions.

Note: there are a couple other early 100th char line breaks in the doc that I did not highlight

Verified that the redirects are working as expected 👍

content/applications/services/helpdesk/advanced/track_and_bill.rst

samueljlieber · 2023-05-09T20:47:30Z

content/applications/services/helpdesk/advanced/track_and_bill.rst

+
+When the :guilabel:`Time Billing` feature is enabled, a new product is created in the *Sales* app
+called :guilabel:`Service on Timesheets`. This product can be found under :menuselection:`Sales -->
+Products --> Products`. Search for `Service on Timesheets` in the :guilabel:`search bar`. This is


Note: I feel that search bar warrants a guilabel since we are telling the user to input text into it

Note: I feel that search bar warrants a guilabel since we are telling the user to input text into it

Agreed, in that case it would be...

:guilabel:`Search...` bar

...since that's the text as it appears on the UI.

content/applications/services/helpdesk/advanced/track_and_bill.rst

jero-odoo · 2023-05-10T14:36:27Z

@samueljlieber Let me know if you have any questions, thanks!

samueljlieber

Hi @jero-odoo 👋 great job with this PR - I left two very minor suggestions, please see them below and implement them as you see fit. Otherwise, I feel this PR is ready for a final review! Please tag @StraubCreative once you're ready 🙂

content/applications/services/helpdesk/advanced/track_and_bill.rst

samueljlieber · 2023-05-15T13:35:14Z

content/applications/services/helpdesk/advanced/track_and_bill.rst

+made, an invoice can be created, and the customer can be billed.
+
+To do this, return to the :abbr:`SO (sales order)` by clicking on the :guilabel:`Sales Order` smart
+button at the top of the :guilabel:`Helpdesk Ticket`.


Noting this as I could see the guilabel use either way here, differing to @StraubCreative's expertise 🙂

Suggested change

button at the top of the :guilabel:`Helpdesk Ticket`.

button at the top of the *Helpdesk* ticket.

I will refer to the "After Sales" doc, since there were a lot of references to smart buttons in that one. In that instance, we settled on the following format- 'A :guilabel:Return smart button will then be added to the top of the
ticket.'
So guilabel for the smart button, and then just 'ticket' for the actual ticket (no Helpdesk). @StraubCreative, let me know if you disagree. 👍

I will refer to the "After Sales" doc, since there were a lot of references to smart buttons in that one. In that instance, we settled on the following format- 'A :guilabel:Return smart button will then be added to the top of the ticket.' So guilabel for the smart button, and then just 'ticket' for the actual ticket (no Helpdesk). @StraubCreative, let me know if you disagree. 👍

Agree with this.
It's the most straightforward option without forcing the need for unnecessary formatting

jero-odoo · 2023-05-15T14:18:03Z

@StraubCreative This one is ready for you, thanks!

StraubCreative

Hi @jero-odoo
Thorough as always 🤌
There's a couple things we'll want to fix before merge, everything else is for your consideration.
Thanks and tag me again when you're ready.

content/applications/services/helpdesk/advanced/track_and_bill.rst

StraubCreative · 2023-05-25T23:47:56Z

content/applications/services/helpdesk/advanced/track_and_bill.rst

+a :guilabel:`Team`. This will reveal that team's :guilabel:`Pipeline`. Click :guilabel:`New` to
+create a new ticket.


team and pipeline do not get guis 😉

I'd also encourage using more frequent compound sentences, especially for simple instructions or "yea yea yea" content that they may have already read prior in the doc. This is so readers can just read it as one continuous statement, e.g., "do the thing in 1, 2, 3," or skip it if they want.

Suggested change

a :guilabel:`Team`. This will reveal that team's :guilabel:`Pipeline`. Click :guilabel:`New` to

create a new ticket.

a team, which will will reveal that team's pipeline. Click :guilabel:`New` to create a new ticket.

While I agree that pipeline does need a guilabel, in this case, I do believe 'team' deserves a guilabel, because I am referring to the kanban card for a team on the main Helpdesk dashboard.
I understand it may seem inconsistent that sometimes team is labeled and sometimes it is not, but is usually the case of referring to a team in general or directing the user to select a team as part of an action.

content/applications/services/helpdesk/advanced/track_and_bill.rst

jero-odoo · 2023-05-26T13:33:45Z

@StraubCreative Ready for your review, let me know about the two guilabels. Thanks 👍

StraubCreative

Continuing convo on those guis @jero-odoo
See below 🙂

StraubCreative · 2023-05-31T00:17:23Z

content/applications/services/helpdesk/advanced/track_and_bill.rst

+
+When the :guilabel:`Time Billing` feature is enabled, a new product is created in the *Sales* app
+called :guilabel:`Service on Timesheets`. This product can be found under :menuselection:`Sales -->
+Products --> Products`. Search for `Service on Timesheets` in the :guilabel:`search bar`. This is


Note: I feel that search bar warrants a guilabel since we are telling the user to input text into it

Agreed, in that case it would be...

:guilabel:`Search...` bar

...since that's the text as it appears on the UI.

content/applications/services/helpdesk/advanced/track_and_bill.rst

StraubCreative

@robodoo r+

jero-odoo · 2023-06-01T12:14:44Z

Hi @jcs-odoo the PR has been merged, can you update the links as discussed? Thank you!

C3POdoo requested a review from a team March 31, 2023 13:27

jero-odoo self-assigned this Mar 31, 2023

jero-odoo requested a review from a team April 10, 2023 15:01

ksc-odoo reviewed Apr 18, 2023

View reviewed changes

samueljlieber force-pushed the 16.0-helpdesk-track-and-bill-time-jero branch from 5ed4075 to 9430a54 Compare April 18, 2023 19:35

jero-odoo commented Apr 19, 2023

View reviewed changes

content/applications/services/helpdesk/advanced/track_and_bill.rst Outdated Show resolved Hide resolved

odoo deleted a comment from jero-odoo Apr 19, 2023

jero-odoo force-pushed the 16.0-helpdesk-track-and-bill-time-jero branch from 9430a54 to 8e9151a Compare April 19, 2023 18:56

jero-odoo requested a review from samueljlieber April 20, 2023 19:20

samueljlieber requested changes Apr 20, 2023

View reviewed changes

samueljlieber force-pushed the 16.0-helpdesk-track-and-bill-time-jero branch from 8e9151a to ad36786 Compare April 20, 2023 20:44

samueljlieber approved these changes Apr 21, 2023

View reviewed changes

samueljlieber requested a review from StraubCreative April 21, 2023 13:14

jcs-odoo reviewed May 3, 2023

View reviewed changes

StraubCreative requested changes May 9, 2023

View reviewed changes

StraubCreative requested a review from samueljlieber May 9, 2023 15:55

StraubCreative added the repeat designation for PRs worth a second look label May 9, 2023

samueljlieber requested changes May 9, 2023

View reviewed changes

jero-odoo force-pushed the 16.0-helpdesk-track-and-bill-time-jero branch from ad36786 to b570eb2 Compare May 10, 2023 14:13

C3POdoo requested a review from a team May 10, 2023 14:32

jero-odoo requested a review from samueljlieber May 10, 2023 14:36

samueljlieber approved these changes May 15, 2023

View reviewed changes

jero-odoo force-pushed the 16.0-helpdesk-track-and-bill-time-jero branch from b570eb2 to 92beae4 Compare May 15, 2023 14:06

jero-odoo requested a review from StraubCreative May 15, 2023 14:18

StraubCreative requested changes May 26, 2023

View reviewed changes

jero-odoo force-pushed the 16.0-helpdesk-track-and-bill-time-jero branch from 92beae4 to f78697a Compare May 26, 2023 13:28

jero-odoo requested a review from StraubCreative May 26, 2023 13:33

StraubCreative requested changes May 31, 2023

View reviewed changes

StraubCreative force-pushed the 16.0-helpdesk-track-and-bill-time-jero branch from f78697a to e2244f8 Compare May 31, 2023 21:54

[IMP] helpdesk: combine and update invoice time docs

c65632d

StraubCreative force-pushed the 16.0-helpdesk-track-and-bill-time-jero branch from e2244f8 to c65632d Compare May 31, 2023 21:55

StraubCreative approved these changes May 31, 2023

View reviewed changes

robodoo closed this in b7efbb6 May 31, 2023

robodoo temporarily deployed to merge May 31, 2023 23:32 Inactive


		Checking the box for :guilabel:`Timesheets` causes a new field to appear, labeled Project.

		This project selected in this field is where all the timesheets for this team's tickets will be

		As new lines are added to Timesheets tab, the Remaining Hours on SO field is automatically
		updated.

		If the number of hours on the :guilabel:`Timesheets` tab goes over the number of hours sold, the
		:guilabel:`Remaining Hours of SO` will turn red.


		Fill out the :guilabel:`Quotation` with the :guilabel:`Customer` information.

		On the Order Lines tab, click :guilabel:`Add a Product`. Select the post-paid services

	button at the top of the :guilabel:`Helpdesk Ticket`.
	button at the top of the Helpdesk ticket.

		a :guilabel:`Team`. This will reveal that team's :guilabel:`Pipeline`. Click :guilabel:`New` to
		create a new ticket.

	a :guilabel:`Team`. This will reveal that team's :guilabel:`Pipeline`. Click :guilabel:`New` to
	create a new ticket.
	a team, which will will reveal that team's pipeline. Click :guilabel:`New` to create a new ticket.

[IMP] helpdesk: combine and update invoice time docs #3974

[IMP] helpdesk: combine and update invoice time docs #3974

Uh oh!

Conversation

jero-odoo commented Mar 31, 2023

Uh oh!

robodoo commented Mar 31, 2023

Uh oh!

ksc-odoo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

samueljlieber commented Apr 18, 2023

Uh oh!

Uh oh!

jero-odoo commented Apr 19, 2023

Uh oh!

samueljlieber left a comment

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!

Choose a reason for hiding this comment

Uh oh!

jero-odoo commented Apr 21, 2023

Uh oh!

samueljlieber commented Apr 21, 2023

Uh oh!

jcs-odoo left a comment

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!

StraubCreative left a comment

Choose a reason for hiding this comment

Uh oh!

samueljlieber left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

StraubCreative May 31, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

StraubCreative May 31, 2023 •

edited

Loading

StraubCreative May 31, 2023 •

edited

Loading