This commit improves the structure of the accounting documentation by
- reducing the levels necessary to reach the information
- grouping some docs
- moving content to their parent category page (content in all levels)
- renaming some sections to reflect the structure of the app better
task-3330093
closesodoo/documentation#4470
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Adding a doc page on performance monitoring and analysis for eCommerce
websites
closesodoo/documentation#3866
Taskid: 3246984
Signed-off-by: Platteau Xavier (xpl) <xpl@odoo.com>
Adding a page on customer interaction and adding redirects. Forward to
master.
closesodoo/documentation#3775
Taskid: 3224716
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Adding a page on customer accounts for the eCommerce doc. Forward to
master.
closesodoo/documentation#3769
Taskid: 3223001
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Adding a page on handling orders for the eCommerce doc, and removing
older pages. Forward to master.
closesodoo/documentation#3721
Taskid: 3214065
Signed-off-by: Aarab Tom (toaa) <toaa@odoo.com>
Adding ewallets/giftcards section to the eCommerce doc. Forward to
master.
closesodoo/documentation#3739
Taskid: 3215674
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
This commit adds custom anchors, links and new see also sections
task-3212218
closesodoo/documentation#3712
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
A translator notified me that one of the sentences in English made no
sense, so I'm fixing it to 1) make sense now 2) make it easier for the
translator.
Small fix, this page will be depecrated when I have time to make a new
one.
Forward to master.
closesodoo/documentation#3709
Taskid: 3211784
X-original-commit: f4ede744ae
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Added a shipping page to the eCommerce section. Forward to master.
closesodoo/documentation#3229
Taskid: 3111638
Signed-off-by: Aarab Tom (toaa) <toaa@odoo.com>
Current documentation doesn't feature any pricing management info.
Forward to master.
closesodoo/documentation#3046
Taskid: 3086649
Signed-off-by: Aarab Tom (toaa) <toaa@odoo.com>
RST cleanup to comply with the RST guidelines. This is required so we
can use "make test", as there are currently hundreds of errors. For now,
it is unusable because of the oldest code in this repo.
closesodoo/documentation#3581
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Adding a cross/upselling page for the ecommerce section. Forward to
master.
closesodoo/documentation#3367
Taskid: 3142720
Signed-off-by: Aarab Tom (toaa) <toaa@odoo.com>
Adding a documentation on payment providers specifically for the
ecommerce section.
closesodoo/documentation#3346
Taskid: 3138597
Signed-off-by: Aarab Tom (toaa) <toaa@odoo.com>
Adding new page on checkout process for eCommerce. Forward to master.
closesodoo/documentation#3192
Taskid: 3110554
Signed-off-by: Aarab Tom (toaa) <toaa@odoo.com>
Adding add to cart page to the eCommerce section. Forward to master.
closesodoo/documentation#3175
Taskid: 3099603
Signed-off-by: Aarab Tom (toaa) <toaa@odoo.com>
Previous page was mostly on the sales app. New page focuses on ecommerce
with :ref: to sales. Forward to master.
closesodoo/documentation#3299
Taskid: 3121379
Signed-off-by: Aarab Tom (toaa) <toaa@odoo.com>
Adding a product page for the eCommerce section, currently does not
exist. V16, forward to master.
closesodoo/documentation#3112
Taskid: 2903859
Signed-off-by: Aarab Tom (toaa) <toaa@odoo.com>
Changing the name of model payment.acquirer to payment.provider
and everything that it touches. It is technically incorrect to
use the term "acquirer" for systems that only provide a service
of payment.
After this commit the model payment.acquirer and everything
related to it will be renamed to payment.provider.
Task - 2842088
closesodoo/documentation#1981
Related: odoo/upgrade#3542
Related: odoo/odoo#90899
Related: odoo/enterprise#27131
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Google deprecated both its "Universal Analytics" and "Google Sign-In"
API. See community counterpart commit for a detailed explanation and
links.
closesodoo/documentation#2499
X-original-commit: 0d01565ac3
Related: odoo/odoo#96280
Related: odoo/enterprise#29666
Related: odoo/upgrade#3698
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Romain Derie (rde) <rde@odoo.com>
task - 2904108 I removed the "website/publish" section from the toctree to add a link to the full website documentation inside off the see also.
closesodoo/documentation#2420
X-original-commit: 7307dac6a6
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Before this commit, the "Developer/Misc" directory of the doc, and
more particularly the "Developer/Misc/Other" sub-directory, was used as
a garbage dump where we moved all the pages that didn't fit elsewhere.
Due to that, interesting and important pages, such as the Coding
Guidelines, were buried in that directory never to be read again by Odoo
developers.
This commit moves most pages under "Misc" one or two levels up to be
located directly under "Developer" hence making them more accessible. A
new "Contributing/Development" directory is added to host the Coding
Guidelines page and soon many other pages.
task-2897143
closesodoo/documentation#2381
X-original-commit: 12ff9f118b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Since odoo/documentation#903, the guideline for the location of new
resource (images, downloadable files, RST includes...) files is to place
those inside the directory of the RST page that references them.
For example, if `doc1.rst` has a reference to `image.png` and to
`download.zip`, the file structure should look like this:
├── parent_doc/
│ └── doc1/
│ │ └── image.png
│ │ └── download.zip
│ └── doc1.rst
│ └── doc2.rst
├── parent_doc.rst
Before this commit, most of the resource files were still located inside
'media' directories holding all the resource files referenced by RST
pages located at the same level as these directories. In the example
above, a single 'media' directory would hold all the resource files
referenced by both `doc1.rst` and `doc2.rst`. Doing so prevented us from
figuring out easily which resource file was referenced by which RST page
and, thus, lead to unused resource files piling up in the repository. It
also made it more complicated to define codeowners regex rules because a
team could not simply be assigned to `/some_page.*` but needed to be
assigned to both `/some_page\.rst` and to the location of 'media'.
In order to help new content writers figure out the guideline when
taking examples from other RST pages, this commit retroactively applies
the guideline to existing resource files and 'media' directories. The
left-over resource files that are not referenced by any RST page are
removed.
task-2497965
Part-of: odoo/documentation#2068
Creation of a new submenu under Applications/General for the Email communication.
Moved advanced of dicuss to this new submenu + adding of content regarding
frequently asked question in support.
Redirection has been done on other files pointing to Discuss/Advanced to match
the new folder email_communication.
Modified content in:
- Email servers: split and move configuration part under email_domain
- Email domain: covering information about SPF DKIM and DMARC configurations by JQU
- Email templates: (how to use the functions) by GOR
- Email common: answering frequently asked questions + common issues by ALA
closesodoo/documentation#1550
X-original-commit: ce8a02d46a
Signed-off-by: Vergote Baptiste (bve) <bve@odoo.com>
The "Payment Acquirers" category was moved to the /general/ folder
(Miscellaneous section) when the super-categories such as "Finance"
didn't exist yet. Now, it makes more sense to move this category to
"Finance".
task-id 2743227
X-original-commit: cbe6aad9e9
Part-of: odoo/documentation#1507
When searching for a string that can be found in a TOC page's content,
that page is listed in the search results. This is not a wanted behavior
because TOC pages without the 'show-content' metadata directive are not
supposed to be accessible.
This commit adds a 'nosearch' metadata directive to all TOC pages
without a 'show-content' metadata directive, hence removing them from
search results.
task-2527419
This commit is part of a larger work to improve the documentation's
structure. The toctree structure used to add levels to create categories
and make the structure visually more understandable.
With the new version of the documentation, plenty of these categories
are now redundant.
This commit:
- removes the main "settings" section
- move its content to general/odoo_basics
- moves "general/mobile" content to "general"
- moves the content of the doc "developer_mode/activate" to "general"
- it replaces the references to that doc with `:ref:` directives
rather than `:doc:` directives
- it is worth noting that it also fixes plenty of links that
previously referred to "developer_mode" (the category) rather than
"developer_mode/activate" (the document)
task-2535899
This commit is part of a larger work to improve the documentation's
structure. The toctree structure used to add levels to create categories
and make the structure visually more understandable.
With the new version of the documentation, plenty of these categories
are now redundant.
This commit improves the structure of the "general" section:
- moves the content of "payment_acquirers/payment_acquirers" to its
parent page, as main content for this category.
It also improves the content of the note about sensitive data.
task-2535899
Removes unnecessary, straightforward, easy-to-figure out documentation, as part of an effort to '
clear out any sort of documentation that is either too easy, too simple,
or already gone over in the tutorial videos. This documentation falls into that category. Hence,
it was removed entirely.
As per the documentation, it is possible to show inventory availability under ecommerce without
installing Inventory app which is incorrect. Made the appropriate changes.
Prior to this commit, the Odoo documentation was mainly split between
two repositories: odoo/odoo/doc and odoo/documentation-user. Some bits
of documentation were also hosted elsewhere (e.g., wiki, upgrade, ...).
This was causing several problems among which:
- The theme, config, Makefile, and similar technical resources had to
be duplicated. This resulted in inconsistent layout, features, and
build environments from one documentation to another.
- Some pages did not fit either documentation as they were relevant
for both users and developers. Some were relevant to neither of the
two (e.g., DB management).
- Cross-doc references had to be absolute links and they broke often.
- Merging large image files in the developer documentation would bloat
the odoo/odoo repository. Some contributions had to be lightened to
avoid merging too many images (e.g., Odoo development tutorials).
- Long-time contributors to the user documentation were chilly about
going through the merging process of the developer documentation
because of the runbot, mergebot, `odoo-dev` repository, etc.
- Some contributors would look for the developer documentation in the
`odoo/documentation-user` repository.
- Community issues about the user documentation were submitted on the
`odoo/odoo` repository and vice-versa.
Merging all documentations in one repository will allow us to have one
place, one theme, one work process, and one set of tools (build
environment, ...) for all of the Odoo docs.
As this is a good opportunity to revamp the layout of the documentation,
a brand new theme replaces the old one. It features a new way to
navigate the documentation, centered on the idea of always letting the
reader know what is the context (enclosing section, child pages, page
structure ...) of the page they are reading. The previous theme would
quickly confuse readers as they navigated the documentation and followed
cross-application links.
The chance is also taken to get rid of all the technical dangling parts,
performance issues, and left-overs. Except for some page-specific JS
scripts, the Odoo theme Sphinx extension is re-written from scratch
based on the latest Sphinx release to benefit from the improvements and
ease future contributions.
task-2351938
task-2352371
task-2205684
task-2352544
Closes#945
