- Notifications
You must be signed in to change notification settings - Fork 10.9k
[IMP] sign: updates for 19.0 #15321
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
base: 19.0
Are you sure you want to change the base?
[IMP] sign: updates for 19.0 #15321
Conversation
580472e to 53ab209 Compare 30e1956 to 57de52a Compare | @xpl-odoo , @auva-odoo Edited to add: in the 51 country pages, it's only the link back to the main Odoo Sign page that was updated (due to the restructuring); no other changes to those pages. |
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.
@mcsi-odoo First of all, thank you so much for this PR 🙏
This is massive work and I really want to acknowledge the amount of time, care, and energy you put into it; it really shows!!
I also want to acknowledge upfront that I’ve left… a lot of comments 😅 As usual, please treat these as discussion points rather than strict instructions, and absolutely push back or ask for clarification anywhere.
That being said, I have some general feedback:
- In many cases (though not all), users need to configure a feature before they can use it. When that’s the case, it might make more sense for the documentation to reflect that flow (covering the configuration first, then usage).
- Small reminder that menu paths always start with the app’s name
- Finally, as a general rule, I find that screenshots of menus are not needed, unless the menu is particularly obscure or hard to find (for example, some accounting reports' options).
Again, thank you (seriously!!) for the huge amount of work here. I’m very happy to discuss any of the points above if needed, for whatever reason!
| .. tip:: | ||
| When adding a field to a document or document envelope, change the size of the field | ||
| manually by hovering over the bottom right of the field until the horizontal, vertical or | ||
| diagonal double arrows appear, then drag the edge of the box until it reaches the desired | ||
| size. |
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.
Since these instructions aren’t performed here (and the information is already included where it belongs), maybe it would be more helpful to rephrase this tip:
| .. tip:: | |
| When adding a field to a document or document envelope, change the size of the field | |
| manually by hovering over the bottom right of the field until the horizontal, vertical or | |
| diagonal double arrows appear, then drag the edge of the box until it reaches the desired | |
| size. | |
| .. tip:: | |
| The size of the field can also be changed manually when :ref:`adding a field to a document <sign/prepare-document/add-fields>` or :ref:`document envelope <sign/prepare-document/create-envelope>`. |
| <sign/fields/auto-fill>`, e.g., name, email, etc., click :guilabel:`Download` to immediately | ||
| download a fully signed version, without having to complete the fields manually. | ||
| | ||
| #. Complete and sign the document, then click :guilabel:`Validate & Send Completed Document`. |
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.
If you're signing mulitple documents at once (as part of a document envelope I suppose?), you have to click Next Document first (or use the arrows in the top-right corner above the document) to navigate to the next document, fill all the fields on the next document, and then click Validate & send Completed Document.
| -------------------------- | ||
| | ||
| A document envelope allows you to upload multiple documents at once, or to add additional documents | ||
| after the initial upload, and send them for signing in a single signature request. It is also |
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.
| after the initial upload, and send them for signing in a single signature request. It is also | |
| after the initial upload, and sign them together or send them for signing in a single signature request. It is also |
I'd also add a ref here that links to the relevant section in the sign_received_documents.rst file (once you've added it; see my comment on that file)
| | ||
| #. From :menuselection:`Sign --> Documents --> My Documents` or :menuselection:`--> All Documents`, | ||
| or :menuselection:`Sign --> Templates`, click the :icon:`fa-cog` :guilabel:`(Actions)` icon | ||
| beside the name of the view, then :menuselection:`Import from Documents`. |
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.
I would not mention templates here and instead add a tip in the template section about 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.
(duplicate comment, edited to remove it)
task-5106515
57de52a to ea66bdb Compare | Thank you for the thorough review, Audrey, as always!! I've incorporated almost all your feedback, and replied to your comments on some points where I didn't fully agree.
P.S. If, for whatever reason, you don't get to review this next week, no problem at all. I'm already happy to be bouncing this back (my brain will be thankful!), and if it's possible for you to re-review while this is still fresh in your mind, that's a big bonus 😉 Happy holidays!! |
auva-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.
@mcsi-odoo Thanks for the updates! I didn’t see any replies to comments though (only resolved ones 🙈), I hope I didn't miss anything!
Re templates: after going through the PR again, I still feel like having one bigger section could be helpful, but let’s definitely discuss that after the holidays.
Thanks again for all the changes and no problem at all about creating a separate task for the remaining topics.
| .. image:: request_signatures/signature-request-send.png | ||
| :alt: Configuring a signature request when sending a document for signing |
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.
I'd remove this screenshot and the related image file since the more complex parts are shown and explained below now.
| .. image:: sign_document/chatter.png | ||
| :alt: Document and certificate of complete added to a record's chatter | ||
| :scale: 80% |
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.
i'd remove this screenshot and the related image file
| #. From the dropdown beside :guilabel:`Linked to` select the model, e.g., *Contact*, that contains | ||
| the field you want to link to. | ||
| #. Click beside :guilabel:`Linked Field`, then use the field selector to select the relevant field | ||
| e.g., Email. |
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.
| #. From the dropdown beside :guilabel:`Linked to` select the model, e.g., *Contact*, that contains | |
| the field you want to link to. | |
| #. Click beside :guilabel:`Linked Field`, then use the field selector to select the relevant field | |
| e.g., Email. | |
| #. From the dropdown beside :guilabel:`Linked to`, select the model, e.g., *Contact*, that contains | |
| the field you want to link to. | |
| #. Click beside :guilabel:`Linked Field`, then use the field selector to select the relevant field, | |
| e.g., Email. |
| - enable the following additional authentication methods, manage the service, and buy credits: | ||
| | ||
| - :ref:`Aadhaar eSign <sign/security/authentication-aadhaar>` (available in India) | ||
| - :ref:`itsme® <sign/security/authentication-itsme>` (available in the EU, the UK, Norway and |
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.
| - :ref:`itsme® <sign/security/authentication-itsme>` (available in the EU, the UK, Norway and | |
| - :ref:`itsme® <sign/security/authentication-itsme>` (available in the EU, the UK, Norway, and |
| <sign/request-signatures/template>` to streamline the signature request process when the same | ||
| document or document envelope needs to be sent regularly. | ||
| | ||
| Once a document or document envelope has been fully signed, i.e. signed by all signers, the signed |
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.
| Once a document or document envelope has been fully signed, i.e. signed by all signers, the signed | |
| Once a document or document envelope has been fully signed, i.e., completed and signed by all signers, the signed |
| #. When all required fields have been completed click :guilabel:`Validate & Send Completed | ||
| Document` at the bottom of the document. | ||
| | ||
| If there are multiple documents to sign, click :guilabel:`Next` at the bottom of the document, |
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.
i'd refer to the document envelope section
| @@ -0,0 +1,199 @@ | |||
| =============== | |||
| Sign a document | |||
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 job on adding the first section in this file; I thought it was really thorough and helpful! Thank you!
| | ||
| #. Open the document: | ||
| | ||
| - From the Sign app: In :menuselection:`Sign --> Documents --> My Documents` or |
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.
| - From the Sign app: In :menuselection:`Sign --> Documents --> My Documents` or | |
| - From the Sign app: Go to :menuselection:`Sign --> Documents --> My Documents` or |
| background; these fields are populated as soon as the document is opened. | ||
| | ||
| .. example:: | ||
| In the example below, the :guilabel:`Name` and :guilabel:`Signature` fields are mandatory |
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.
| In the example below, the :guilabel:`Name` and :guilabel:`Signature` fields are mandatory | |
| In the example below, the :guilabel:`Name` and :guilabel:`Signature` fields are mandatory, |
| :ref:`'adopt' your signature and initials <sign/sign-document/initials-signature>` if you | ||
| are an external user or an internal user signing in Odoo Sign for the first time. | ||
| | ||
| #. When all required fields have been completed click :guilabel:`Validate & Send Completed |
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.
| #. When all required fields have been completed click :guilabel:`Validate & Send Completed | |
| #. When all required fields have been completed, click :guilabel:`Validate & Send Completed |

task-5106515