documentation/content/applications/productivity/discuss/mail_twitter.rst
Antoine Vandevenne (anv) e3fee2cf46 [REF][MOV] documentation apocalypse
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
2021-05-04 15:44:00 +02:00

41 lines
1.5 KiB
ReStructuredText

====================================
How to follow Twitter feed from Odoo
====================================
.. image:: media/twitter_user-image.png
:align: center
You can follow specific hashtags on Twitter and see the tweets within the
Odoo Discuss channels of your choice. The tweets are retrieved periodically from Twitter.
An authenticated user can retweet the messages.
Setting up the App on Twitter's side
====================================
Twitter uses an "App" on its side which is opens a gate to which Odoo asks for
tweets, and through which a user can retweet.
To set up this app, go to http://apps.twitter.com/app/new and put in the values:
- Name: this is the name of the application on Twitter
- Website: this is the external url of your Odoo database, with "/web" added.
For example, if your Odoo instance is hosted at "http://www.example.com", you
should put "http://www.example.com/web" in this field.
- Callback URL: this is the address on which Twitter will respond. Following the
previous example you should write "http://www.example.com/web/twitter/callback".
Do not forget to accept the terms **Developer agreement** of use and click on
**Create your Twitter application** at the bottom of the page.
Getting the API key and secret
==============================
When on the App dashboard, switch to the **Keys and Access Tokens** tab.
.. image:: media/api_key.png
:align: center
And copy those values in Odoo in :menuselection:`Settings--> General Settings--> Twitter discuss integration`
and click on **Save** to save the settings.