[ADD] events: added complete documentation

[ksc-odoo]

Task ID: 2941079

There was no documentation for the Events app, so I created documentation for v14 (which can also be directly applied to v15).

[robodoo]

Pull request status dashboard.

[ksc-odoo]

Hey @mivu-odoo

There was no documentation for Events whatsoever in v14 or v15. Can you please review the content to make sure everything looks okay? EBJ has already looked over the content for accuracy.

Once I get your approval, I'll forward it over to Zac.

Thanks!

[samueljlieber]

Hey @mivu-odoo and @ksc-odoo!

I fixed the build errors - just so you are aware, here is what was causing the errors 🙂

1. events.rst was not included in the marketing.rst .. toctree::
2. Image :align: & :alt: tags were not properly indented underneath the .. image:: tag
3. There were a few trailing spaces left throughout the documents
4. On line 17 of selling_tickets.rst there was an internal reference to a document that doesn't exist
5. A few :guilabel: tags weren't formatted correctly

[ksc-odoo]

@StraubCreative Ready for your review!

[StraubCreative]

Hi @ksc-odoo

Thanks for the contribution and tagging me in.

For this review I corrected and expanded on the content only in create.rst since I saw similar issues that need to be addressed on the other docs.

Please use the feedback on the change requests below, along with the voluminous feedbacks offered in #2552 and #2534 as a guide to making changes for selling_tickets.rst and track_manage_talks.rst.

I have already made all/most of the changes locally on my copy of create.rst and can push those up with your agreement. Do take the time to review all of the change requests individually since there are requests for rewrites, expansions, and screenshot adjustments for this doc.

Here's an overview of the recurring items to address here on this PR, as well as what's popped up on the last couple PRs:

• Screenshots are either not in HD or are too large. Some screenshots are not needed. Reference..
• Specificity of language: be specific, always (especially for headings) and avoid vague statements. Be thorough in walking through the UI while providing contextual instruction. Do not use marketing/corporate language in technical documentation.
• Showing vs. telling: show the reader how to do things, don't just simply point at things on the UI or feature dump
• Passive or inconsistent tense: write in the simple present tense with an assertive voice. Avoid passive language as much as possible, such as may should would could it is possible etc. It's okay to tell the reader what to do since that's why they're here: to learn! 😉
• Avoid personal pronouns and 2nd-person familiar language, and stick to third-person instructional. The best way to avoid using people as the subject in sentences is to stick with action-based direction around the UI, e.g., "First, do this...then, do this...lastly...do this"
• Missing context clues: remember, documentation readers typically skim the content, so it's important that we constantly remind the reader where we are at any given time. At the beginning of most paragraphs (especially after a lengthy instruction), we can say things like "Now that the questions setting is enabled..." to give them a clue on what just happened, and that, in this case, enabling the setting was necessary to proceed. As well, time order language helps guide the reader and pulls them right into the action on sections that are relevant to them.
• Wrong or inconsistent tag markup: use the RST cheatsheet as a guide for tagging.
• Missing opportunities to use call-out tags, such as note tip example etc. These call-outs help break up walls of text, are a really useful visual aid to bring attention to important details for the reader, and the documentation itself really comes to life with all the colors 🤩 Reference.

EDIT: expanded list items and added contextual links.

[StraubCreative]

Updated partial content for create.rst on 8b98d7e.

Fixed CI errors on b2c8f69.

Guidelines on further changes for this PR located on the original review comment + nested feedbacks here. Outstanding items for create.rst were left as unresolved. For comments that are resolved, use these as micro-guides to expand on the broader details listed in the parent review note in order to improve the rest of create.rst, as well as selling_tickets.rst and track_manage_talks.rst.

@ksc-odoo you're good for next round of updates, TIA! 🚀

[samueljlieber]

Updates in 2f71152

• fixed build errors
  • removed trailing white spaces
  • fixed a few lines over 100 chars
• added seealso tags at the end of each doc
• verified that @StraubCreative's outstanding items were completed in @ksc-odoo's commit c5dc505 👍

[StraubCreative]

Hi @ksc-odoo and @samueljlieber

Thank you for making most of the changes from the last review.
I have another batch, particularly for create.rst.

While there was some improvement, we're running into some similar issues as last time:

• screenshots are too large, awkwardly cropped, or not needed
• wording/flow improvements
• precise vs. vague language
• missing or improper use of RST tags (mostly guilabels)

Please address for create.rst and reflect the change requests to the other documents as well, if they're needed.

Ideally, with the scope of changes outlined here (and other Marketing PRs, for reference), I'd like to be able to look at selling_tickets.rst and track_manage_talks.rst (and their respective image folders) and they'd be more or less perfect across:

• content accuracy and depth
• wording, flow and grammar, and
• RST formatting (including screenshots)

Good improvement this round, with some more to go.
Give it another shot and lemme know when we're ready for another look, thanks! 😉

[samueljlieber]

Hey @ksc-odoo thanks for image/gif suggestions. I decided to use the gif for this doc, I think it works well!

I also fixed the build errors in the doc 👍

[StraubCreative]

Hi @ksc-odoo

Very well done. These were great to read 👍

I have a number of small suggestions to close us out, mostly related around line breaks and use of parenthesis in the body content.

Please review the suggestions, and indicate if you agree with them, or specify which ones you do not want to include. After that, I can push up all of the revisions and pass to DR.

Again, well done. Looking forward to your reply!

[ksc-odoo]

Hi @ksc-odoo

Very well done. These were great to read 👍

I have a number of small suggestions to close us out, mostly related around line breaks and use of parenthesis in the body content.

Please review the suggestions, and indicate if you agree with them, or specify which ones you do not want to include. After that, I can push up all of the revisions and pass to DR.

Again, well done. Looking forward to your reply!

@StraubCreative I fully approve all the suggestions, so feel free to push up all of the revisions and pass to DR. Thanks again for all your help with this! It is very much appreciated!

[StraubCreative]

Thanks @ksc-odoo and @samueljlieber for all of your work on this.
Looks great. Passing to DR.

@odoo/doc-review this new documentation on Events app is ready for your review.

[StraubCreative]

Addressed latest change requests on 60b04ae.

Ready for another look, @AntoineVDV 🙏

[AntoineVDV]

@robodoo r+