[DOC] tours #11467
Open
[DOC] tours #11467
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
C3POdoo
requested review from
a team,
kmagusiak and
ryv-odoo
and removed request for
a team
bastien-ipb
force-pushed
the
18.0-tour_documentation-ipb
branch
2 times, most recently
from
a553a90
to
377c4c3
Compare
bastien-ipb
force-pushed
the
18.0-tour_documentation-ipb
branch
from
377c4c3
to
95adf64
Compare
AntoineVDV
requested changes
Nov 27, 2024
Comment on lines
+740
to
+741
| The main purpose of the onboarding tours is to guide the user. They can be started with the | ||
| checkbox in the user menu that will run all the onboarding tours in their sequence order. |
There was a problem hiding this comment.
Suggested change
| The main purpose of the onboarding tours is to guide the user. They can be started with the | |
| checkbox in the user menu that will run all the onboarding tours in their sequence order. | |
| The main purpose of onboarding tours is to guide the user. They can be started using the | |
| checkbox in the user menu to run all the onboarding tours in their sequence order. |
There was a problem hiding this comment.
These are some fat images to commit on the repo; please compress them with pngquant
Comment on lines
+740
to
+744
| The main purpose of the onboarding tours is to guide the user. They can be started with the | ||
| checkbox in the user menu that will run all the onboarding tours in their sequence order. | ||
|
|
||
| .. image:: testing/tour_user_menu.png | ||
| :align: center |
There was a problem hiding this comment.
Actually I don't think that you need to add (and maintain) an image just for that:
Suggested change
| The main purpose of the onboarding tours is to guide the user. They can be started with the | |
| checkbox in the user menu that will run all the onboarding tours in their sequence order. | |
| .. image:: testing/tour_user_menu.png | |
| :align: center | |
| The main purpose of the onboarding tours is to guide the user. They can all be started in their sequence order by toggling the :guilabel:`Onboarding` option in the user menu. |
Comment on lines
+757
to
+761
| ├── static | ||
| | └── src | ||
| | └── js | ||
| | └── tours | ||
| | └── your_tour.js |
There was a problem hiding this comment.
Alternatively:
Suggested change
| ├── static | |
| | └── src | |
| | └── js | |
| | └── tours | |
| | └── your_tour.js | |
| ├── static/src/js/tours/your_tour.js |
Comment on lines
+780
to
+783
| The javascript part is the same as for the test tour. | ||
|
|
||
| .. seealso:: | ||
| - :ref:`testing/javascript/test` |
There was a problem hiding this comment.
Suggested change
| The javascript part is the same as for the test tour. | |
| .. seealso:: | |
| - :ref:`testing/javascript/test` | |
| The javascript part is the same as for ref:`the test tour <testing/javascript/test>`. |
Comment on lines
+815
to
+817
| Like said previously, you can activate the onboarding tour with the checkbox in user menu, | ||
| but you can also run specific ones through the menu: ``Settings/Technical/User Interface/Tours``. | ||
| In this view you'll get all the onboarding tours and you can execute them by clicking on `onboarding` or `testing`. |
There was a problem hiding this comment.
With moving the intro here in mind:
Suggested change
| Like said previously, you can activate the onboarding tour with the checkbox in user menu, | |
| but you can also run specific ones through the menu: ``Settings/Technical/User Interface/Tours``. | |
| In this view you'll get all the onboarding tours and you can execute them by clicking on `onboarding` or `testing`. | |
| You can run specific onboarding tours by going to the :menuselection:`Settings --> Technical --> User Interface --> Tours` and clicking on :guilabel:`Onboarding` or :guilabel:`Testing`. |
There was a problem hiding this comment.
Given that this explanation is straightforward, I think that the second image should be removed too.
Comment on lines
+830
to
+834
| You can also create tour easily with the tour recorder, that will popup by clicking on `Record` on the | ||
| onboarding tours view. When started, this tool will record all your interactions in Odoo. | ||
|
|
||
| The created tours are listed in the onboarding tours view as `custom`. these tours can also | ||
| be exported to javascript file, ready to be put in your module. |
There was a problem hiding this comment.
Suggested change
| You can also create tour easily with the tour recorder, that will popup by clicking on `Record` on the | |
| onboarding tours view. When started, this tool will record all your interactions in Odoo. | |
| The created tours are listed in the onboarding tours view as `custom`. these tours can also | |
| be exported to javascript file, ready to be put in your module. | |
| You can also create tours easily with the tour recorder. To do so, click on :guilabel:`Record` on the | |
| onboarding tours view. When started, this tool will record all your interactions in Odoo. | |
| The created tours are flagged in the onboarding tours view as **Custom**. These tours can also | |
| be exported to a javascript file, ready to be put in your module. |
| there is a default value. If you do not want a rainbow_man effect, then specify | ||
| the field and write nothing as value. | ||
|
|
||
| Running onboarding tour |
There was a problem hiding this comment.
Suggested change
| Running onboarding tour | |
| Running onboarding tours |
Comment on lines
-785
to
+886
| Run via browser | ||
| *************** | ||
| Run test tour via browser | ||
| ************************* |
There was a problem hiding this comment.
I think it's fine as "Run via browser" considering it's a nested section.
| the URL, then selecting **Start Tour** in the debug menu and picking a | ||
| tour: | ||
|
|
||
| .. image:: testing/tours.png |
There was a problem hiding this comment.
Remove the image as well.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.