[ADD] accounting: add document for l10n_in_edi #1940

nidhi9698 · 2022-05-06T13:26:58Z

add documentation for l10_in_edi

robodoo · 2022-05-06T13:27:27Z

Pull request status dashboard.

jco-odoo · 2022-06-07T12:16:53Z

At first sight, this looks more or less ok to me. I think @odoo/doc-review can already have a look as well. @tsb-odoo

jco-odoo · 2022-06-07T12:17:23Z

@jcs-odoo

jcs-odoo · 2022-06-07T13:07:40Z

Hi @jco-odoo ! :)
When the PR is ready to be merged, @odoo/accounting-doc-review would have been added automatically as a reviewer.
I can have a first quick look if you'd like.
I'm also thinking of a way to have some common structure for localization pages, but we can still improve this later if needed.

jcs-odoo

Hello @nia-odoo !

I haven't read everything yet, but here are already a few comments.
I'm wondering, mostly, if you intend to work a lot on the documentation. If not, I could ask one of the content writers to improve your PR based on your work.
But if you're willing to improve it yourself, then I'll happily help :)

So here is the first batch of comments.

Write "e-invoice" in sentence case, unless it is in a :guilabel: that requires to follow the interface's capitalization.
please follow the content guidelines about media files which includes
- media filenames are meaningful
- with hyphens instead of underscores
- in a media folder which name is similar to the rst file (so not a "media" folder)
- Ideally, retake the screenshots (guidelines are not up to date, here)
- reduce the width of the screen to have more content on less pixels
- select only the zone that matters. Taking full screen screenshots isn't useful.
- no need to illustrate everything with a screenshot. There are often way too many screenshots, which dillutes the information in a needlessly longer page. Try to limit the number of screenshot in your doc.
- Remember that the information must be written, and the screenshot illustrates. It doesn't replace the written content.
- the png files must be compressed with pngquant
- go to the line at the 100th character (see guidelines)
- Please adapt the capitalization of your headings. See the content guidelines about headings and titles capitalization

Have a good day :)

jcs-odoo · 2022-06-07T13:19:39Z

content/applications/finance/accounting/fiscal_localizations/localizations/india.rst

+Introduction
+============


Suggested change

Introduction

============

Installation

============

jcs-odoo · 2022-06-07T13:36:14Z

content/applications/finance/accounting/fiscal_localizations/localizations/india.rst

+Introduction
+============
+
+The Indian localization has been improved and extended in Odoo v15. In this version, the next modules are available:


I'd rather avoid mentioning versions whenever possible. Normally, users read the doc in the version they are using.
I write sometimes from which version a feature is available, but it's better to avoid it.

jcs-odoo · 2022-06-07T13:37:26Z

content/applications/finance/accounting/fiscal_localizations/localizations/india.rst

+- **l10n_in:** Adds accounting features for the Indian localization, which represent the minimal
+  configuration required for a company to operate in India. The main elements included in this module are two formats of Chart of Accounts i.e Indian Chart Of Accounts - Standard and Indian Chart Of Accounts - Schedule VI.
+
+- **l10n_in_edi:** Includes all technical and functional requirements to submit invoicing
+  through API to the government.


Could you try presenting this the same way I did here for egypt?
https://github.com/odoo/documentation/blob/15.0/content/applications/finance/accounting/fiscal_localizations/localizations/egypt.rst

If not, it's not a problem, but I'm considering having the same structure for all localization pages at some point.

jcs-odoo · 2022-06-07T13:38:30Z

content/applications/finance/accounting/fiscal_localizations/localizations/india.rst

+Install the Indian localization modules
+----------------------------------------
+
+For this, go to *Apps* and search for ``l10n_in``. Then click *Install* in the module **Indian - E-invoicing**. This module has a dependency with **Indian - Accounting**. In case this last
+one is not installed, Odoo installs it automatically with E-invoicing.
+
+.. image:: media/india_edi_01.png
+   :align: center
+   :alt: Installation of the Indian localization module in Odoo Apps
+
+.. note::
+   When you install a database from scratch selecting India as country, Odoo will automatically install the base module: Indian - Accounting.


If you change the previous heading to an installation one, then this part becomes redundant.

The installation process and screenshot are detailed in the installation ref link for those who need to know how to do it.

jcs-odoo · 2022-06-08T16:02:39Z

content/applications/finance/accounting/fiscal_localizations/localizations/india.rst

+Setup E-invoice Service
+------------------------


See the content guidelines about headings and titles capitalization
https://www.odoo.com/documentation/master/contributing/documentation/content_guidelines.html#titles-and-headings

jcs-odoo · 2022-06-08T16:08:43Z

content/applications/finance/accounting/fiscal_localizations/localizations/india.rst

+   For the creation of an API username and password please refer to this document:
+   https://service.odoo.co.in/einvoice_create_api_user


This seems weird to me.

why is part of the documentation on a pdf?

why is it hosted on service.odoo.co.in?

If there is information on the government's website, you can link it in a seealso section. If it's our own explanation, I'd rather explain it with words in the documentation, and avoid having too many screenshots.

If we end up keeping a pdf file, I'd rather add it to the repo here, in the "india" folder (the one for the images as well)

jcs-odoo · 2022-06-08T16:16:56Z

content/applications/finance/accounting/fiscal_localizations/localizations/india.rst

+Journal Configuration
+----------------------
+
+To configure you journals go to :menuselection:`Accounting --> Configuration --> Journals`:


Suggested change

To configure you journals go to :menuselection:`Accounting --> Configuration --> Journals`:

To configure your journals go to :menuselection:`Accounting --> Configuration --> Journals`:

jcs-odoo · 2022-06-08T17:11:45Z

content/applications/finance/accounting/fiscal_localizations/localizations/india.rst

+
+To configure you journals go to :menuselection:`Accounting --> Configuration --> Journals`:
+
+Open your sales journal. Under the Advanced Settings tab, in the *Electronic invoicing* field, check E-Invoice (IN) and Save. By default, it is *Checked* for sales journals.


could you use :guilabel: for elements that are on-screen and :menuselection: for tabs?

Suggested change

Open your sales journal. Under the Advanced Settings tab, in the *Electronic invoicing* field, check E-Invoice (IN) and Save. By default, it is *Checked* for sales journals.

Open your sales journal. Under the :menuselection:`Advanced Settings` tab, in the

:guilabel:`Electronic Invoicing` field, check :guilabel:`E-Invoice (IN)` and Save.```

nidhi9698 · 2022-06-13T05:23:27Z

Hello @jcs-odoo

I will improve it according to the guidelines and comments.

Thank you

jva-odoo · 2022-08-08T10:44:41Z

@jcs-odoo can you plz add this or review it,
we must need this when the user is asking how to start Indian EDI.

toaa-odoo

Hi! Thanks for your work. I recommend following the suggestions I have made to better suit the guidelines for online documentation.

As for the images, we no longer use red rectangles or arrows to indicate where to click, etc. :)

content/applications/finance/accounting/fiscal_localizations/localizations/india.rst

nidhi9698 · 2022-08-24T12:58:00Z

Hello @toaa-odoo, I have made changes according to your suggestions.

Thanks.

toaa-odoo

Thanks for your work again! It's much closer to the guidelines.

I noticed the images' size is a bit big, did you compress them by doing pngquant (path file) ? If yes, then no problem! If not, please compress them. There's also an extra line to remove.

I will approve it, but make sure to update the PR before @jcs-odoo reviews it.

content/applications/finance/accounting/fiscal_localizations/localizations/india.rst

nidhi9698 · 2022-08-26T12:56:39Z

Thanks for your work again! It's much closer to the guidelines.

I noticed the images' size is a bit big, did you compress them by doing pngquant (path file) ? If yes, then no problem! If not, please compress them. There's also an extra line to remove.

I will approve it, but make sure to update the PR before @jcs-odoo reviews it.

Hello @toaa-odoo, Yes, I have already compressed all images using pngquant, and the changes are done.

Thanks.

nidhi9698 · 2022-08-31T13:19:17Z

Hello @jcs-odoo,
Can you please review this PR and merge it before the freeze

Thanks.

jcs-odoo · 2022-08-31T14:12:13Z

Hi @nia-odoo
I'll push some changes directly on this branch today to make the process faster this time, then.
We're a bit overwhelmed and have to - sadly - postpone plenty of tasks and reviews. I didn't realize this one was time-sensitive.

nidhi9698 · 2022-09-01T12:12:15Z

Hi @jcs-odoo ,
I think you have added two images of the e-invoice-process by mistakenly. Can you please look into this

jcs-odoo · 2022-09-01T12:27:09Z

Hi @jcs-odoo , I think you have added two images of the e-invoice-process by mistakenly. Can you please look into this

Good catch! Thank you @nia-odoo =)

jcs-odoo · 2022-09-01T12:27:39Z

@nia-odoo does it look okay like that for you?

nidhi9698 · 2022-09-01T12:50:31Z

@nia-odoo does it look okay like that for you?

Yes, It looks good to me 😊

jco-odoo

@jcs-odoo I quickly went through it. It would be nice if it could be merged.

content/applications/finance/accounting/fiscal_localizations/localizations/india.rst

Co-authored-by: Jonathan Castillo <jcs@odoo.com>

jcs-odoo · 2022-09-01T19:41:22Z

@robodoo r+

jva-odoo requested review from jco-odoo and tsb-odoo June 7, 2022 11:03

jcs-odoo requested changes Jun 8, 2022

View reviewed changes

nidhi9698 force-pushed the 15.0-l10n_in-edi-doc-nia branch from ccf0db8 to 99a873f Compare June 20, 2022 08:36

nidhi9698 marked this pull request as ready for review August 8, 2022 10:42

nidhi9698 requested a review from jcs-odoo August 8, 2022 10:43

C3POdoo requested a review from a team August 8, 2022 10:43

toaa-odoo suggested changes Aug 16, 2022

View reviewed changes

nidhi9698 force-pushed the 15.0-l10n_in-edi-doc-nia branch 2 times, most recently from 13e813c to 44baa81 Compare August 23, 2022 09:31

toaa-odoo approved these changes Aug 26, 2022

View reviewed changes

content/applications/finance/accounting/fiscal_localizations/localizations/india.rst Outdated Show resolved Hide resolved

nidhi9698 force-pushed the 15.0-l10n_in-edi-doc-nia branch from 44baa81 to 5189787 Compare August 26, 2022 12:45

jcs-odoo force-pushed the 15.0-l10n_in-edi-doc-nia branch 2 times, most recently from 3ec2a28 to 735670f Compare September 1, 2022 08:26

jcs-odoo requested a review from toaa-odoo September 1, 2022 08:27

toaa-odoo approved these changes Sep 1, 2022

View reviewed changes

jcs-odoo force-pushed the 15.0-l10n_in-edi-doc-nia branch from df08786 to ca0d87b Compare September 1, 2022 11:59

jcs-odoo approved these changes Sep 1, 2022

View reviewed changes

jcs-odoo requested a review from a team September 1, 2022 12:00

jcs-odoo force-pushed the 15.0-l10n_in-edi-doc-nia branch from ca0d87b to df6c16e Compare September 1, 2022 12:26

jco-odoo approved these changes Sep 1, 2022

View reviewed changes

content/applications/finance/accounting/fiscal_localizations/localizations/india.rst Outdated Show resolved Hide resolved

[ADD] accounting/l10n: new localization page for India

cf78703

Co-authored-by: Jonathan Castillo <jcs@odoo.com>

jcs-odoo force-pushed the 15.0-l10n_in-edi-doc-nia branch from df6c16e to cf78703 Compare September 1, 2022 14:00

robodoo closed this in 028c670 Sep 1, 2022

fw-bot mentioned this pull request Sep 1, 2022

[FW][ADD] accounting: add document for l10n_in_edi #2660

Closed

robodoo temporarily deployed to merge September 1, 2022 20:49 Inactive

This was referenced Sep 1, 2022

[FW][ADD] accounting: add document for l10n_in_edi #2661

Closed

[FW][ADD] accounting: add document for l10n_in_edi #2662

Closed

		For the creation of an API username and password please refer to this document:
		https://service.odoo.co.in/einvoice_create_api_user

	To configure you journals go to :menuselection:`Accounting --> Configuration --> Journals`:
	To configure your journals go to :menuselection:`Accounting --> Configuration --> Journals`:


		To configure you journals go to :menuselection:`Accounting --> Configuration --> Journals`:

		Open your sales journal. Under the Advanced Settings tab, in the Electronic invoicing field, check E-Invoice (IN) and Save. By default, it is Checked for sales journals.

	Open your sales journal. Under the Advanced Settings tab, in the Electronic invoicing field, check E-Invoice (IN) and Save. By default, it is Checked for sales journals.
	Open your sales journal. Under the :menuselection:`Advanced Settings` tab, in the
	:guilabel:`Electronic Invoicing` field, check :guilabel:`E-Invoice (IN)` and Save.```

		Setup E-invoice Service
		------------------------

[ADD] accounting: add document for l10n_in_edi #1940

[ADD] accounting: add document for l10n_in_edi #1940

Uh oh!

Conversation

nidhi9698 commented May 6, 2022

Uh oh!

robodoo commented May 6, 2022

Uh oh!

jco-odoo commented Jun 7, 2022

Uh oh!

jco-odoo commented Jun 7, 2022

Uh oh!

jcs-odoo commented Jun 7, 2022

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!

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!

nidhi9698 commented Jun 13, 2022

Uh oh!

jva-odoo commented Aug 8, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

toaa-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!

nidhi9698 commented Aug 24, 2022

Uh oh!

toaa-odoo left a comment • 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!

nidhi9698 commented Aug 26, 2022

Uh oh!

nidhi9698 commented Aug 31, 2022

Uh oh!

jcs-odoo commented Aug 31, 2022

Uh oh!

nidhi9698 commented Sep 1, 2022

Uh oh!

jcs-odoo commented Sep 1, 2022

Uh oh!

jcs-odoo commented Sep 1, 2022

Uh oh!

nidhi9698 commented Sep 1, 2022

Uh oh!

jco-odoo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jcs-odoo commented Sep 1, 2022

Uh oh!

jva-odoo commented Aug 8, 2022 •

edited

Loading

toaa-odoo left a comment •

edited

Loading