-
Notifications
You must be signed in to change notification settings - Fork 10.8k
[IMP] l10n: update AR documentation #2430
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
|
Hey @StraubCreative 😄 |
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.
Here's the first batch of changes I'd like to see. A lot of the suggestions revolve mostly around the written content itself, with only a few RST corrections, namely:
- Grammar, wording, and sentence structure
- Suggestions to improve written context (and not rely so much on images)
- Improvements around content placement i.e. text goes before images.
cc: @vbe-odoo
content/applications/finance/accounting/fiscal_localizations/localizations/argentina.rst
Outdated
Show resolved
Hide resolved
content/applications/finance/accounting/fiscal_localizations/localizations/argentina.rst
Outdated
Show resolved
Hide resolved
content/applications/finance/accounting/fiscal_localizations/localizations/argentina.rst
Outdated
Show resolved
Hide resolved
content/applications/finance/accounting/fiscal_localizations/localizations/argentina.rst
Outdated
Show resolved
Hide resolved
content/applications/finance/accounting/fiscal_localizations/localizations/argentina.rst
Outdated
Show resolved
Hide resolved
content/applications/finance/accounting/fiscal_localizations/localizations/argentina.rst
Outdated
Show resolved
Hide resolved
content/applications/finance/accounting/fiscal_localizations/localizations/argentina.rst
Outdated
Show resolved
Hide resolved
content/applications/finance/accounting/fiscal_localizations/localizations/argentina.rst
Show resolved
Hide resolved
content/applications/finance/accounting/fiscal_localizations/localizations/argentina.rst
Show resolved
Hide resolved
content/applications/finance/accounting/fiscal_localizations/localizations/argentina.rst
Show resolved
Hide resolved
ba457a1 to
dddd341
Compare
|
Thanks for all of the info in each suggestion! I made all of the requested changes except for items that need content/information from the l10n team. I left those items unresolved and I will work with the team to get the content :) cc: @vbe-odoo |
|
Looks good @samueljlieber. Very quick work 🙂 Two errors I found which are contributing to the failed ci/doc check.
One is a hyperlink issue (not properly formatted). The other is a failed image reference (e.g. image missing, file path wrong in RST, etc.) Be sure to run |
dddd341 to
1749d82
Compare
content/applications/finance/accounting/fiscal_localizations/localizations/argentina.rst
Outdated
Show resolved
Hide resolved
1749d82 to
c4ddd9c
Compare
|
Hi @vbe-odoo, @StraubCreative's remaining content suggestions: |
content/applications/finance/accounting/fiscal_localizations/localizations/argentina.rst
Outdated
Show resolved
Hide resolved
content/applications/finance/accounting/fiscal_localizations/localizations/argentina.rst
Show resolved
Hide resolved
c4ddd9c to
9c00302
Compare
|
Hi @gza-odoo 👋 thank you for making these suggestions! |
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 first round of revisions everyone. The doc looks much better and more readable than where it started 😄
Thank you @samueljlieber for the speedy updates and @gza-odoo for the content suggestions.
Here's the next batch of changes which mostly include some more grammar/formatting suggestions in trying to tighten things up.
I think after these are implemented, we can open the PR up to the Accounting team 👍
content/applications/finance/accounting/fiscal_localizations/localizations/argentina.rst
Outdated
Show resolved
Hide resolved
content/applications/finance/accounting/fiscal_localizations/localizations/argentina.rst
Outdated
Show resolved
Hide resolved
content/applications/finance/accounting/fiscal_localizations/localizations/argentina.rst
Outdated
Show resolved
Hide resolved
content/applications/finance/accounting/fiscal_localizations/localizations/argentina.rst
Outdated
Show resolved
Hide resolved
content/applications/finance/accounting/fiscal_localizations/localizations/argentina.rst
Show resolved
Hide resolved
content/applications/finance/accounting/fiscal_localizations/localizations/argentina.rst
Outdated
Show resolved
Hide resolved
content/applications/finance/accounting/fiscal_localizations/localizations/argentina.rst
Outdated
Show resolved
Hide resolved
content/applications/finance/accounting/fiscal_localizations/localizations/argentina.rst
Outdated
Show resolved
Hide resolved
content/applications/finance/accounting/fiscal_localizations/localizations/argentina.rst
Outdated
Show resolved
Hide resolved
content/applications/finance/accounting/fiscal_localizations/localizations/argentina.rst
Outdated
Show resolved
Hide resolved
9c00302 to
88a5326
Compare
|
Commit 88a5326 updated document per ZST's suggestions (Thank you 🙏). Remaining suggestions: |
|
We need just two quick things here @gza-odoo @vbe-odoo After those I think we can open the PR to Accounting team 🚀 |
88a5326 to
a8a21b0
Compare
|
Hi @StraubCreative, I updated the two points in my previous comment with the comments the team provided, thank you @vbe-odoo and @gza-odoo! Regarding the typo that says Also regarding @gza-odoo's comment I made a small change for context clarity: |
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.
@gza-odoo thank you for the content updates!
@samueljlieber nice catch with the capitalizations in the list items. Let's go one step further and remove the nested colons from the list.
After this is edited we can make the PR live for Accounting team to review 🚀
content/applications/finance/accounting/fiscal_localizations/localizations/argentina.rst
Outdated
Show resolved
Hide resolved
content/applications/finance/accounting/fiscal_localizations/localizations/argentina.rst
Outdated
Show resolved
Hide resolved
content/applications/finance/accounting/fiscal_localizations/localizations/argentina.rst
Outdated
Show resolved
Hide resolved
|
I'm ok with what you suggest @samueljlieber :) |
a8a21b0 to
587d30d
Compare
|
Hi @StraubCreative, your edits have been made 👍 |
|
Thanks @samueljlieber for the quick changes 🙏 I'm going to open this up to Accounting for review now. Note: |
|
Thank you @toaa-odoo 😀 your suggestions have been implemented in 15b7bab. Hi @vbe-odoo and @gza-odoo can you help me determine how we should label
Thank you! ⭐️ |
Hi @samueljlieber I think we should use this one "Argentinean localization" as is the one that we have in the database and on the screenshots, as both are OK, let's keep the one we have been using when installing l10n_ar in a database, as it will more difficult to change the name there (and on the screenshots) than in this DOC. Let me know what are your thoughts on this. |
|
@vbe-odoo I think your suggestion is the way to go - I will update the document to use "Argentinean localization". Thanks! |
15b7bab to
a02776e
Compare
|
Commit a02776e to update CC: @toaa-odoo |
toaa-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.
Great work, you won't hear from me again! :)
Tagging @jcs-odoo for final review.
|
@jcs-odoo wanted to review it |
a02776e to
53b451c
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.
Apologies for this huge delay 🙈
I didn't go into detail for the whole doc but in general, I think this doc could refer more to the rest of the doc. Normally, we would add doc links or custom anchors to specific headings in "see also" sections.
Also, I think that there are too many images, but it's also okay like that for now. I saw that they were not compressed with pngquant and that you forgot to delete the old images that are not useful anymore.
I already applied these changes and a few typos I caught here and there. I'll push them on this branch in a few minutes
|
|
||
| - `VIDEO WEBINAR OF A COMPLETE DEMO <https://youtu.be/c41-8cVaYAI>`_. | ||
| - `ECOMMERCE <https://youtu.be/5gUi2WWfRuI>`_. | ||
| - `VIDEO WEBINAR V15 <https://www.youtube.com/watch?v=_H1HbU-wKVg>`_. |
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.
Avoid using versions in the content. The version switcher in the doc indicates the user the version of the current page, but typing this in the page means that it is ported to other versions and requires more maintenance of the doc.
Also, we should write "Odoo 15" instead of "v15"
| Configure your company | ||
| ~~~~~~~~~~~~~~~~~~~~~~ |
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.
These headings' level seem weird.
I don't see why "configure your company" and "chart of accounts" are listed as a sublevel of "install the argentinean.
| Configure your company | |
| ~~~~~~~~~~~~~~~~~~~~~~ | |
| Configure your company | |
| ---------------------- |
| Introduction | ||
| ============ | ||
|
|
||
| The Argentinean localization has been improved and extended in Odoo v13, in this version the next | ||
| modules are available: | ||
| The following modules are necessary for all databases that require Argentinean localization: | ||
|
|
||
| - **l10n_ar**: This module add accounting features for the Argentinian localization, which represent | ||
| the minimal configuration needed for a company to operate in Argentina and under the AFIP | ||
| (Administración Federal de Ingresos Públicos) regulations and guidelines. | ||
| - **l10n_ar**: adds accounting features for the Argentinean localization, which represent the | ||
| minimal configuration needed for a company to operate in Argentina and under the AFIP | ||
| (Administración Federal de Ingresos Públicos) regulations and guidelines; | ||
|
|
||
| - **l10n_ar_reports**: Add VAT Book report which is a legal requirement in Argentine and that holds | ||
| the VAT detail info of sales or purchases recorded on the journal entries. This module includes as | ||
| well the VAT summary report that is used to analyze the invoice | ||
| - **l10n_ar_reports**: adds the VAT Book report which is a legal requirement in Argentina and that | ||
| holds detailed VAT information of sales or purchases recorded on the journal entries. This module | ||
| includes the VAT summary report as well, which is used to analyze the invoice; | ||
|
|
||
| - **l10n_ar_edi**: This module includes all technical and functional requirements to generate | ||
| Electronic Invoice via web service, based on the AFIP regulations. | ||
| - **l10n_ar_edi**: includes all technical and functional requirements to generate Electronic | ||
| Invoices via web service, based on the AFIP regulations. | ||
|
|
||
| The following module is optional and should be installed only if it meets a specific organization | ||
| requirement: | ||
|
|
||
| - **l10n_ar_website_sale**: allows the user to see Identification Type and AFIP Responsibility in | ||
| the eCommerce checkout form in order to create electronic invoices. | ||
|
|
||
| Configuration | ||
| ============= | ||
|
|
||
| Install the Argentinean localization modules | ||
| -------------------------------------------- | ||
|
|
||
| For this, go to *Apps* and search for Argentina. Then click *Install* for the first two modules. | ||
| Go to :guilabel:`Apps` and search for `l10n_ar` either in the apps/module list or by using the | ||
| search box. Then click :guilabel:`Install` for all of the Argentinean Modules. | ||
|
|
||
| .. image:: argentina/argentina01.png | ||
| .. image:: argentina/install-argentinian-l10-modules.png | ||
| :align: center | ||
| :alt: Install Argentinean localization modules. |
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 is not an introduction and is rather part of the configuration.
- I suggest using the same format as the latest localization pages to indicate which module to install
No need to explain everything everytime in the doc. It is best to add a link to the doc that explains how to install a module rather than explaining it on every page, with a screenshot.
I suggest replacing line 13 to 46 with this (and deleting the screenshot)
Configuration
=============
Modules installation
--------------------
:ref:`Install <general/install>` the following modules to get all the features of the Argentinean
localization:
.. list-table::
:header-rows: 1
:widths: 25 25 50
* - Name
- Technical name
- Description
* - :guilabel:`Argentina - Accounting`
- `l10n_ar`
- Default :doc:`fiscal localization package <../overview/fiscal_localization_packages>`, which
represents the minimal configuration to operate in Argentina under the :abbr:`AFIP
(Administración Federal de Ingresos Públicos)` regulations and guidelines.
* - :guilabel:`Argentinean Accounting Reports`
- `l10n_ar_reports`
- VAT Book report and VAT summary report.
* - :guilabel:`Argentinean Electronic Invoicing`
- `l10n_ar_edi`
- Includes all technical and functional requirements to generate electronic invoices via web
service, based on the AFIP regulations.
* - :guilabel:`Argentinean eCommerce`
- `l10n_ar_website_sale`
- (optional) Allows the user to see Identification Type and AFIP Responsibility in the
eCommerce checkout form in order to create electronic invoices.
53b451c to
86d25c1
Compare
|
Pinging for merge already so we can move forward. We can still improve afterwards if needed :) |
|
Thanks for the review @jcs-odoo cc: @samueljlieber |
AntoineVDV
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.
@robodoo r+
| Localization` and choose either :guilabel:`Prueba (Testing)` or :guilabel:`Produccion (Production)` | ||
| . |
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.
| Localization` and choose either :guilabel:`Prueba (Testing)` or :guilabel:`Produccion (Production)` | |
| . | |
| Localization` and choose either :guilabel:`Prueba (Testing)` or :guilabel:`Produccion (Production)`. |
| :alt: A list showing less common Argentinean tax options, which are labeled as inactive in Odoo | ||
| by default. | ||
|
|
||
| .. _document-types: |
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 would conflict with any other document-types anchor added later in the doc, which is likely to happen.
| .. _document-types: | |
| .. _localizations/argentina/document-types: |
| Argentina case: AFIP). | ||
| In some Latin American countries, like Argentina, some accounting transactions such as invoices and | ||
| vendor bills are classified by document types defined by the governmental fiscal authorities. In | ||
| Argentina, the `AFIP <https://www.afip.gob.ar/>`__ is the governmental fiscal authority that |
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.
Use single underscores in links.
| Argentina, the `AFIP <https://www.afip.gob.ar/>`__ is the governmental fiscal authority that | |
| Argentina, the `AFIP <https://www.afip.gob.ar/>`_ is the governmental fiscal authority that |
| - Condition applied based on the type of Issues and Receiver (ex. Type of fiscal regimen of | ||
| the buyer and type of fiscal regimen of the vendor) | ||
| - The journal entry related to the invoice (if the journal uses documents); | ||
| - The onditions applied based on the type of issuer and receiver (e.g., the type of fiscal regime of |
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.
| - The onditions applied based on the type of issuer and receiver (e.g., the type of fiscal regime of | |
| - The conditions applied based on the type of issuer and receiver (e.g., the type of fiscal regime of |
| :align: center | ||
| For auditing and troubleshooting purposes, it is possible to obtain detailed information of an | ||
| invoice number that has been previously sent to the AFIP. To retrieve this information, go into | ||
| :doc:`Developer Mode <../../../../general/developer_mode>`, then go to the |
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.
Either:
- use
docand start from the root to limit the number of../:/applications/general/developer_mode - use
ref(exceptionally) with the targetdeveloper-mode.
Task ID: #2908400