For some reason, the first-person was used throughout the IAP
documentation, and quite inconsistently.
As the rest of the documentation is using second-person writing, IAP
should be no exception.
closesodoo/documentation#6327
X-original-commit: df474342ba
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Louis Baudoux (lba) <lba@odoo.com>
It has been decided to remove the possibility for our users to create
their own IAP services.
This decision was motivated by the fact that, in the 5 years of
existence of IAP, very few non-Odoo services have been created and
actively used by our customers.
X-original-commit: 282f041ed1
Part-of: odoo/documentation#6327
A new way to disable IAP accounts has been introduced recently.
This feature is mostly used in neutralization scripts to prevent
customers from accidentaly consuming their credits on their
staging/testing databases.
Documenting it will help users re-enable their accounts if they still
wish to use it in a testing environment.
closesodoo/documentation#6139
X-original-commit: fa604a95b0
Signed-off-by: Louis Baudoux (lba) <lba@odoo.com>
The current default daily limit for one-app free
is 20 mails only. This commit updates the value.
closesodoo/documentation#5515
X-original-commit: c0ca09cdde
Signed-off-by: Jonathan Castillo (jcs) <jcs@odoo.com>
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#4479
X-original-commit: c68cc154ed
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
To improve the structure of the documentation, the "Miscellaneous"
section should be limited as much as possible.
This commit:
- renames "Calendars" into "Calendar" (as the app name)
- moves the app from the "Miscellaneous" section to the "Productivity"
section
- fixes the wrong file structure to follow the toc
(e.g. general/calendars/outlook/outlook_calendar -> productivity/calendar/outlook)
task-3217827
closesodoo/documentation#4128
X-original-commit: 3d2c5d7c16
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
As a first step to update the doc - at last! - we first need to update
its structure.
task-3269837
X-original-commit: 180963cd89
Part-of: odoo/documentation#4129
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#3589
X-original-commit: 7ae76bad42
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
The content written in the fiscal localisation pages are not only for
Accounting, but also for other apps such as Payroll and Point of Sales.
This commit moves the content to the "Finance" level, to better reflect
this reality, and merges the pages in the /overview/ folder in the main
category page.
closesodoo/documentation#3559
X-original-commit: ecbb755471
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
If committed, this will add a more elaborate warning on what users must
do before syncing Odoo Calendar and Outlook Calendar. It also removes
mentions of the import/export process and archiving events, as these
methods will not prevent email spam from Outlook.
closesodoo/documentation#3234
X-original-commit: 5979a772e6
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Michelle (mivu) <mivu@odoo.com>
This commit adds several small information on chapter 1 of the training
owl:
- 1.1 How to get to the playground controller
- 1.2 Add a reference on sub component
- 1.4 How to activate the dev mode in owl
closesodoo/documentation#3194
X-original-commit: 1bd7e803e0
Signed-off-by: Dardenne Florent (dafl) <dafl@odoo.com>
Customer may want to use their own SMTP for email marketing, and Odoo default SMTP for everything else. There is no good way to do this. Previously we suggested adding Odoo SMTP as an outgoing email server but we don't want to share credentials anymore.
R&D is working on a solution (e.g. showing the Odoo default email server in the list rather than keeping it as an "hidden feature") but for the time being, if you use an outgoing email server, you give up using the Odoo default SMTP.
closesodoo/documentation#2771
X-original-commit: 7b21e6001b
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
Codeowner regexes need images to be in the correct location, otherwise
some image files might not be assigned to a GitHub team when the regex
covering the parent folder is split into multiple codeowner rules.
closesodoo/documentation#1777
X-original-commit: 4e0a9b615f
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
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
The "Enable IPN" step is also removed because this setting is overruled
by the payment request that Odoo sends to PayPal. Enabling IPN in PayPal
has no effect.
task-2744043
closesodoo/documentation#1489
X-original-commit: b97ca3f44d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Add payment methods supported by Odoo
This will inform users of Stripe which payment method we currently
support.
task-2685143
closesodoo/documentation#1483
X-original-commit: 587b2862df
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Valentin Chevalier <vcr@odoo.com>
and ease the way to get the api keys
task-2574512
closesodoo/documentation#1346
X-original-commit: 92ad3e8658
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Morgane Demesmaeker <edm@odoo.com>
The preferred format for (frontend) references is now:
"frontend/filename/section", or something close to that.
closesodoo/documentation#1294
X-original-commit: 894165a949
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
Users couldn't click on Paypal and saw the HTTP link instead of only 'Paypal'
closesodoo/documentation#1176
X-original-commit: a4aa310b85
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
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.
Since other docs were moved away from the section "basics" with previous
commits, this category is renamed "users settings"
This commit:
- renames "basics" into "users settings"
- moves the content from "odoo_basics/users" to "users"
- it moves the content about "access rights" to a child doc
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:
- 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 merges all docs about data import/export into a single doc:
- base_import/import_faq -> export_import_data
- base_import/adapt_template -> export_import_data
- odoo_basics/export-data -> export_import_data
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 merges all docs about unsplash into a single doc:
- "unsplash/unsplash_access_key" -> unsplash
- "unsplash/unsplash_application_id" -> unsplash
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
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:
- it moves the content of the doc "in_app_purchase" to its parent page
"multi_companies"
- it moves the content of the doc "tags/take_tags" to "odoo_basics/tags"
- it moves the content of the doc "manage_multi_companies" to its parent
page "multi_companies"
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 "Accounting" app:
- it moves the doc "in-odoo" in the top "app" level and its content is
included in "accounting.rst" (the content will later be improved)
- adds new intro
- changes external links to mementos to correct doc references
- it renames the category accounting/overview to
accounting/getting_started
- it renames the category accounting/overview/getting_started to
accounting/getting_started/initial_configuration
- it moves "memento" one level above, from
accounting/overview/main_concepts to the renamed
accounting/getting_started as it is the last doc remaining in this
category
- it renames the app "Invoicing and Accounting" to
"Accounting and Invoicing" since the focus should be on "Accounting"
task-2535899
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
