Conversation
|
|
|
Hi @huisit this is ready for a review when you have a moment, thanks! |
huisit
left a comment
huisit
left a comment
There was a problem hiding this comment.
@stepperpig most of my comments are optional suggestions for conciseness or omitting details that are commonly repeated throughout Odoo apps.
I also shared a few formatting suggestions for structure, but that could definitely be saved for a full rewrite if you're planning to do that later on. Otherwise looks good to me, much better than before!
ps: sorry for the premature comments, I'm still getting used to my new kb and kept hitting ctrl + enter on accident 😅
| Start by entering a name for the booth category in the top :guilabel:`Booth Category` field. This is | ||
| a **requried** field. | ||
|
|
||
| To add a corresponding image to the booth category (e.g. a sample photo of how the booth looks), | ||
| click the :icon:`fa-pencil` :guilabel:`(pencil)` icon that appears when the cursor hovers over the | ||
| camera placeholder in the upper-right corner of the booth category form. When clicked, proceed to | ||
| upload the desired image to the booth category form, if needed. | ||
| a **required** field. | ||
|
|
||
| In the :guilabel:`Booth Details` section, users **must** assign a :guilabel:`Product` to the | ||
| category, and it **must** have *Event Booth* set as the *Product Type* on the product form. | ||
| Optionally, upload a corresponding image (e.g., a sample photo of how the booth looks). | ||
|
|
||
| And, regardless of the listed price on the *Event Booth* product chosen, the user can input a custom | ||
| :guilabel:`Price` to be applied for this booth category in the field below. | ||
| In the :guilabel:`Booth Details` section, assign an *Event Booth* product in the :guilabel:`Product` | ||
| field. This a **required** field. |
There was a problem hiding this comment.
consider stating the required fields together first, then optional photo after
| When :doc:`sponsors <event_sponsors>` are enabled in the **Events** app, an additional *Create | ||
| Sponsor* checkbox appears on each record in the list as well as on the booth category form. | ||
|
|
||
| Create booth category |
There was a problem hiding this comment.
consider formatting the list of form fields as a bulleted list
| Additionally, the :guilabel:`Sponsor Level` and :guilabel:`Sponsor Type` fields can be configured to | ||
| specify the level/tier and the type of sponsorship. See the :doc:`event sponsors <event_sponsors>` | ||
| documentation for more information about configuring sponsor levels and types. |
There was a problem hiding this comment.
this is the third time you link to sponsors back to back -- i would remove at least one
if you format as a list, the level/type fields could be nested
| .. tip:: | ||
| The status of the booth (:guilabel:`Available` or :guilabel:`Unavailable`) can also be changed | ||
| manually, either by clicking the appropriate status from the status bar in the upper-right of the | ||
| booth form or by dragging-and-dropping the desired booth into the appropriate stage via the | ||
| *Booths* dashboard Kanban view. |
There was a problem hiding this comment.
try to avoid two admonition blocks in a row, they take up a lot of whitespace/visual weight which can drown out the neighboring next
consider adding available/unavailable as a single sentence/bulleted list, instead of a paragraph tip admonition
| To access the event booths page for a specific event, navigate to the event form in the **Events** | ||
| app and click the :guilabel:`Go to Website` smart button to open the event page. | ||
|
|
||
| While on the event website, enter the edit mode by clicking the :guilabel:`Edit` button in the | ||
| If the event sub-menu (with the :guilabel:`Get A Booth` option) is *not* showing up, there are two | ||
| ways to make it appear. | ||
|
|
||
| While on the event page, enter the edit mode by clicking the :guilabel:`Edit` button in the | ||
| upper-right corner. Then, click into the :guilabel:`Customize` tab of the resulting sidebar of web | ||
| design tools. | ||
|
|
||
| In the :guilabel:`Customize` tab, click the toggle switch for :guilabel:`Sub-Menu (Specific)`, and | ||
| click :guilabel:`Save`. Doing so reveals the event subheader menu with various options. | ||
| In the :guilabel:`Customize` tab, click the toggle switch for :guilabel:`Sub-menu (Specific)`, then | ||
| click :guilabel:`Save`. Doing so reveals the event sub-menu with various options (e.g., Talks, | ||
| Agenda, Info, etc.). | ||
|
|
||
| Alternatively, enter :doc:`Debug mode <../../general/developer_mode>`, and open the specific event | ||
| form in the the *Events* application. | ||
| Alternatively, enter :doc:`Debug mode <../../general/developer_mode>` and open the specific event | ||
| form in the **Events** application. | ||
|
|
||
| On the event form, with *Debug mode* on, an array of subheader menu options appears. Tick the | ||
| checkbox for :guilabel:`Website Submenu`, in order for the submenu to appear on the event website. | ||
| Doing so also ticks every other submenu-related checkbox automatically. | ||
| With *Debug mode* on, an array of sub-menu options appears at the top of the event form. Click the | ||
| checkbox for :guilabel:`Website Submenu` to display the event sub-menu on the event page. | ||
|
|
||
| At this point, proceed to choose which options to keep on the event subheader menu. In this case, | ||
| make sure the :guilabel:`Booth Register` checkbox is ticked. | ||
| Next, choose which sub-menu options to include on the event page. In this case, make sure the | ||
| :guilabel:`Booth Register` checkbox is selected. |
There was a problem hiding this comment.
consider separating the alternative flows. you could use a bullet/numbered list, or subheadings/subsections
| Once the sub-menu is enabled on the event page either through the website editor or through the | ||
| debug mode, renters can then view and reserve available booths. |
There was a problem hiding this comment.
consider starting the section with this, so the reader knows what they're being instructed for
Co-authored-by: Rex <11528309+huisit@users.noreply.github.com>
3 participants
Goal
Update the 'Event booths' page to 18.0. This is a significant overhaul to the overall structure and writing of the doc.
Changelog
Additional Notes
This is a pretty large and somewhat "unfocused" doc which may need further work/restructuring in the future to better target specific user needs.
Version Scope
This PR should be FWP up to master. Additional discrepancies in 19.0 will be targeted in a future PR.