documentation icon indicating copy to clipboard operation
documentation copied to clipboard

[IMP] surveys: improves Surveys doc

Open ksc-odoo opened this issue 4 years ago • 5 comments

Enhanced the Scoring doc. Remove 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.

ksc-odoo avatar Apr 08 '21 20:04 ksc-odoo

We are now using 'intro' pages for all our apps.

As your PR concerns the whole Surveys app, I guess it's a good time to add it. You can check two examples: one is the Accounting and Invoicing intro page, which is structured the following way: A very short intro presenting the app's main features, then a link to the product's page (the app page). Below that, the main features are presented (factually, Wikipedia-style), if possible with a link to actual documentation pages. The Documents intro page follows the same structure, but instead of presenting 'features', we present the documentation content (i.e., flows) directly, as there isn't much (at least for the moment) content foreseen. For Surveys, I feel we could go in either direction, depending on what you have in mind. As of now, there is maybe not enough content for a list of features w/ links to the actual documentation, but I'll let you decide.

To do this intro page, you should edit the survey.rst file under the marketing folder (currently used for the toctree). If you go for the list of features version (e.g. accounting), add the following to your page:

:show-content:

=======
Surveys
=======

.. toctree::
   :titlesonly:

   surveys/xxx
   surveys/yyy

**Odoo Surveys** does x and z

For the Documents approach, it's just a regular doc page, you don't need the :show content: line nor the .. toctree:: Check out 14.0 locally if you want to look at the rst files.

When you move/remove/rename documentation, you should edit the redirects.txt file

You can find it under the main documentation-user folder. Instructions are given at the beginning of the file, and it's relatively easy. You just need to add a line for each redirection using this format: file_path/old_file.rst file_path/new_file.rst # (#PRnumber)

So the three removed pages should, ideally, redirect to your new pages whenever the content is similar (if you remove a page and there is nothing replacing it, you don't use redirects, obviously)

content/applications/marketing/survey/overview/create.rst
content/applications/marketing/survey/overview/scoring.rst
content/applications/marketing/survey/overview/time_random.rst

For example, if you decide to put all the information on the single intro page, your redirects should look like this:

content/applications/marketing/survey/overview/create.rst content/applications/marketing/survey.rst # (#928)
content/applications/marketing/survey/overview/scoring.rst content/applications/marketing/survey.rst # (#928)
content/applications/marketing/survey/overview/time_random.rst content/applications/marketing/survey.rst # (#928)

Additionally:

  1. You should also include the Odoo task number in the commit message (the .txt file you edit on PyCharm). Here is where you can find it in the task URL. Yours for this task is: 2485389
  2. And include a link to the Odoo task on GitHub (i.e., when you submit the PR message on GitHub, which uses your commit message as a basis)

xpl-odoo avatar Jun 02 '21 13:06 xpl-odoo

https://www.odoo.com/web#id=2485389&action=333&active_id=3835&model=project.task&view_type=form&cids=3&menu_id=4720

ksc-odoo avatar Jun 07 '21 21:06 ksc-odoo

Hi @ksc-odoo ! Let me know here or on the project task when you are done making changes so I can give it a second look. I'm asking because I see you have made 14 (!) force push, so I'm not quite sure you are done yet 😃

xpl-odoo avatar Jun 10 '21 12:06 xpl-odoo

Regarding the Odoo task number in the commit message, I see you added it to the commit title, it should be in the message below the title.

xpl-odoo avatar Jun 11 '21 11:06 xpl-odoo

Not sure what happened back then :/ @ksc-odoo it seems this PR has some conflicts to fix. Could you resume it with your current review/merge process once it's fixed? Here it seems that only the surveys team has a review to do, now, but that would be you, so that doesn't make any sense ^^

jcs-odoo avatar Sep 14 '22 12:09 jcs-odoo