-
Notifications
You must be signed in to change notification settings - Fork 10.6k
[ADD] Payroll: adding new configuration doc #4249
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @larm-odoo! Just finished reviewing this. I had suggestions for where information could be added, mostly at the beginning of sections/paragraphs to introduce the topic and explain important vocabulary words and how they relate to Odoo in particular.
Also, something I just checked but didn't comment on in my review: all headings should be in sentence case!
Please let me know if you have any questions!
ddc45dd to
cbb0ea9
Compare
|
Hi @meng-odoo! I made all the edits/suggestions, and added a bit more information/text in the areas you suggested. |
meng-odoo
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @larm-odoo, great job adding info to this doc and making those edits! I had a bunch of small wording suggestions, and a couple more places where I think information could be added. I know this doc already covers so much, but we still want to go through and make sure we explain as much as possible, so that someone reading this doc will have all their questions answered :)
Please let me know if you have any questions!
jcs-odoo
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @larm-odoo
doc structure review:
For the app-level page, could you add a small explanation about what the app is +a link to Odoo Tutorials, like on this page, please?
https://github.com/odoo/documentation/blob/16.0/content/applications/hr/attendances.rst?plain=1
The best would be to put the main, or basic content, on that app-level page.
And for the commit message and PR title, please change the tag to [ADD].
Thanks and have a good day
cbb0ea9 to
5183b97
Compare
|
Thanks @jcs-odoo - made the edits as suggested, and it seems to be working like the example you gave. @meng-odoo - I also made your edits. After checking with Zac, two spots we are leaving as a 'This is for Belgium, and will be updated when the app is updated' explanation, so that is helpful! |
5183b97 to
2f4c82a
Compare
jcs-odoo
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @larm-odoo
Thanks for changing the app page :)
Ideally, the "main" content of the app can go there, or maybe a page describing a default flow, redirecting to all the children pages.
Also, the build failed and indicates there is a missing image. It's the same warning message as when you build the documentation on your computer.
as for the ci/documentation_guidelines test

it indicates you need to add a blank line at the end of the configuration.rst file. This is needed to help git when there are later additions that come at the end of the page.
Have a good day :)
2f4c82a to
8278187
Compare
|
Thanks for the info @jcs-odoo! I fixed the errors for the build, it looks good now. As for the main article, I am going to have an overview doc added after this one, which will link to this. So I will have a lot more info/a walk through for this section. I am just starting with the 'meat'. Does that explain how I made this doc/landing page? |
meng-odoo
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @larm-odoo, this doc is looking great! I just had a few more small suggestions/wording changes, then this should be good to go :)
8278187 to
1f76ac7
Compare
meng-odoo
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @larm-odoo, this doc looks great :) Thanks for all your work on this! I had one single comment this round. Please go ahead and push this doc to the next step after this!
|
Thanks @meng-odoo ! I wasn't sure if I should have tagged you AGAIN, so apologies for
doing that, but thank you so much for all your reviews!
-Lara
…On Tue, May 23, 2023 at 4:07 PM meng-odoo ***@***.***> wrote:
***@***.**** requested changes on this pull request.
Hi @larm-odoo <https://github.com/larm-odoo>, this doc looks great :)
Thanks for all your work on this! I had one single comment this round.
Please go ahead and push this doc to the next step after this!
------------------------------
In content/applications/hr/payroll/configuration.rst
<#4249 (comment)>:
> +types available.
+
+.. image:: configuration/work-entry-types.png
+ :align: center
+ :alt: List of all work entry types currently available.
+
+New work entry type
+~~~~~~~~~~~~~~~~~~~
+
+To create a new :guilabel:`Work Entry Type`, click the :guilabel:`Create` button. Enter the
+information on the form:
+
+- :guilabel:`Work Entry Type Name`: The name should be short and descriptive, such as `Sick Time` or
+ `Public Holiday`.
+
+- :guilabel:`Code`: This code appears with the work entry type on timesheets and payslips. Since
I noticed the word "timesheets" is sometimes written as one word, and
sometimes written as two words ("time sheets"). It would be best to decide
on one and make it consistent throughout the doc.
—
Reply to this email directly, view it on GitHub
<#4249 (review)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/A47DUPFFA62LYLEEY44WV6LXHUKHTANCNFSM6AAAAAAXKAGUOU>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
--
*Lara Martini*
Technical Writer - Odoo Inc.
1 Seneca St
Buffalo, NY 14203
|
1f76ac7 to
4f00199
Compare
samueljlieber
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @larm-odoo 👋 thank you for your continued effort on this PR. I have some more technical changes after taking another look. Please see below and let me know if you have any questions. Please tag me again once this PR is ready 🙂 Thank you!
| the *Timesheets* application, a :guilabel:`Work Entry Type` needs to be selected. The list of | ||
| :guilabel:`Work Entry Types` is automatically created based on localization settings set in the | ||
| database. | ||
|
|
||
| To view the current work entry types available.Go to :menuselection:`Payroll --> Configuration --> | ||
| Work Entry Types` | ||
|
|
||
| Each work entry type has a code to aid in the creation of payslips, and ensure all taxes and fees | ||
| are correctly entered. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This sentence is referring to the records and not the page "Work Entry Types", and while the page heading is Work Entry Types, the focus of the sentence is on the records... so I don't think we need any formatting. But I am curious on @StraubCreative's thoughts here 👇
p.s. also missing a comma, a space before 'go' and a period.
| the *Timesheets* application, a :guilabel:`Work Entry Type` needs to be selected. The list of | |
| :guilabel:`Work Entry Types` is automatically created based on localization settings set in the | |
| database. | |
| To view the current work entry types available.Go to :menuselection:`Payroll --> Configuration --> | |
| Work Entry Types` | |
| Each work entry type has a code to aid in the creation of payslips, and ensure all taxes and fees | |
| are correctly entered. | |
| the *Timesheets* application, a :guilabel:`Work Entry Type` needs to be selected. The list of work | |
| entry types is automatically created based on localization settings set in the database. | |
| To view the current work entry types available, go to :menuselection:`Payroll --> Configuration --> | |
| Work Entry Types`. | |
| Each work entry type has a :guilabel:`Code` to aid in the creation of payslips, and ensure all taxes | |
| and fees are correctly entered. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah these are tough, since I feel the need to explain the why, then the how, and I am using the terms in the UI. I also wonder what @StraubCreative says on this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah these are tough, since I feel the need to explain the why, then the how, and I am using the terms in the UI. I also wonder what @StraubCreative says on this. I'll leave this as unresolved so we see it.
e03492c to
d9a0868
Compare
|
All changes done, @samueljlieber ! Ready for you again =) |
samueljlieber
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @larm-odoo! Just a couple small changes and then you can pass this along to final review. I am approving now be please make these changes before tagging 🙂 great work!
d9a0868 to
9f8c7ff
Compare
|
Hi @StraubCreative - this is ready for you, now! |
meng-odoo
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @larm-odoo! I did a final review of this doc and it looks good to me :) Thanks for your work on this! I'm going to go ahead and tag @StraubCreative for merge.
StraubCreative
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great doc @larm-odoo. Very thorough on an otherwise complex topic, keep it up 👍
I think based on new 2023 guideline we'll want to move all of the content from configuration.rst to payroll.rst to minimize clicks for the user and to avoid pages with lean content. Will make a Task and assign in Project.
@robodoo r+
|
@larm-odoo @StraubCreative unable to stage: merge conflict |
9f8c7ff to
604e7b5
Compare
|
@robodoo retry |
|
I'm sorry, @StraubCreative: retry makes no sense when the PR is not in error. |
|
@robodoo r+ |
closes #4249 Signed-off-by: Zachary Straub (zst) <[email protected]>
closes #4249 Signed-off-by: Zachary Straub (zst) <[email protected]>


New doc for new section of HR, focused on the configuration section.