[IMP] surveys:update get started docs

[ksc-odoo]

Task ID: 2938139

[robodoo]

Pull request status dashboard.

[ksc-odoo]

Hey There @mivu-odoo ,

New content and screenshots for the Surveys documentation. Can you please give this a review? Then I'll send it over to Zac.

Thanks!

[mivu-odoo]

Hi @ksc-odoo just letting you know I pushed a commit to fix some build errors that were keeping the PR from passing the ci/documentation code check! I'll update one again when I do content review!

[mivu-odoo]

Hello @ksc-odoo!

This will be part one of my final review; I figured I can publish these comments so you can get started on the changes while I continue reviewing the other RST files.

This review only contains comments on the create.rst file. Please let me know if you have any questions about them. I will continue reviewing scoring.rst and time_random.rst in the meantime, and notify you when I finish making comments and publish them to this PR.

[mivu-odoo]

Hi @ksc-odoo!

I opened your feature branch up on my computer to see if I can tinker around with the build errors. Surprisingly, my terminal showed a different build error from the one you showed me earlier in the day. I'm wondering if the sphinx configuration on your computer might need to be updated, but that's a question for Zac when he comes back.

I fixed the build errors that were showing on my terminal and pushed commit 1874eed, and the PR is showing that all code checks have passed now.

After I make more comments on this PR, make sure to run git pull --rebase (Step 6 on my Discord message "Follow these steps to make another commit on an existing PR (squash commits) - Part 1") on your feature branch before you start making your next round of revisions, so my commit 1874eed is pulled onto your computer and you're working with the latest version of the branch.

[mivu-odoo]

PR was failing the ci/documentation code check - pushed commits 934e2b6 and 36b7fc2 to delete trailing whitespaces.

PR is passing all checks now.

cc: @ksc-odoo @StraubCreative

[mivu-odoo]

Hello @ksc-odoo!

I left some comments on scoring.rst. There are slight differences in field names between Odoo 14 and Odoo 15. After this PR is merged and forward-ported, we can open another PR targeting the 15.0 branch.

I still have to review time_random.rst, and I might take another pass at create.rst. I will make another comment once I finish looking at those RST files. Feel free to start working on the changes to scoring.rst in the meantime. Thank you!

[mivu-odoo]

Left some comments for time_random.rst! Last thing for me to do is to take a second look at create.rst, but feel free to work on the changes to time_random.rst and scoring.rst while I do that. Thank you!

[StraubCreative]

Updates

As of 09b04e6:

• solved merge conflicts across scoring.rst and time_random.rst
• removed broken links in seealso blocks
• removed trailing whitespaces and fixed a couple line breaks in those docs as well
• rebased on top of latest 14.0

---

Notes

@ksc-odoo the CI checks are not passing on this latest commit due to bountiful trailing whitespaces. You can see them here: https://runbot.odoo.com/runbot/build/21751024.

The checks did not pass on prior commit cc1af20 because there were merge conflicts against 14.0 base branch. This would have been identified before pushing that commit either by running make html or git rebase 14.0, in which case either command would have communicated issues in the terminal readout.

Reminders

• if changes were made to your PR from other collaborators (e.g. solving a merge conflict, fixing syntax, etc.), be sure to run git pull - rebase command in your terminal so those changes are pulled to your computer before making more changes to the branch. Otherwise this creates duplicate work for maintainers (e.g. there should not be trailing whitespace issues after MIVU already fixed them for you).
• rebase on top of a fresh pull from your base branch every time you're about to push commits (in this case, 14.0).
• be mindful of trailing whitespaces and line breaks and do not ask for reviews until you are confident they have been addressed. PRs will not pass review if these are not 100% correct, and repeatedly ignoring these errors, both, risks introducing brittleness to your code and creates more work for everyone.
• do not ignore merge conflict warnings. If you need help solving them, just ask 🙂
• before pushing commits, run make html in your terminal to a) see a live preview of your changes in order to catch html rendering errors, and b) identify/address RST syntax errors that will be spit out in the terminal in red.

---

Next steps

Before continuing content review with @mivu-odoo, please address all of the instructions in this comment and fix all of the CI errors until they pass. Reach out if you need help.

Tip: this extension should help out with trailing whitespaces, as it removes them whenever you save the file.

Thanks!

[StraubCreative]

@ksc-odoo checks are not passing on 8b82984.

The build errors are listed on the ci/documentation Details link at the bottom of the page.

Try again and only request a review when the checks pass.

Thank you.

cc: @mivu-odoo

[samueljlieber]

Updates in b9f7593:

• removed unused images, and images that needed to be redone
• all of @mivu-odoo suggestions

Updates in 9f06c36:

• added two reformatted images (questions-description-options.png & survey-question-pop-up.png)

@mivu-odoo ready for another review 🙂

[StraubCreative]

Fixed commit history in d9c55f5.

[StraubCreative]

Hi @ksc-odoo

This was a pleasure to read. I like how the instructions were really broken down and easy to understand. I also appreciated how each doc was laid out with bite-size paragraphs.

I have a number of change requests to tighten everything up. There are a few CRs that must be addressed due to things like typo/grammar or line breaks, but a majority of them are more or less for your consideration as doc owner.

If you agree with the content changes listed below, I can push them up and we can pass over to DR right away. Otherwise let me know what you'd like to keep or disregard, per comment.

Thanks and looking forward to your response 🙂

[ksc-odoo]

Hi @ksc-odoo

This was a pleasure to read. I like how the instructions were really broken down and easy to understand. I also appreciated how each doc was laid out with bite-size paragraphs.

I have a number of change requests to tighten everything up. There are a few CRs that must be addressed due to things like typo/grammar or line breaks, but a majority of them are more or less for your consideration as doc owner.

If you agree with the content changes listed below, I can push them up and we can pass over to DR right away. Otherwise let me know what you'd like to keep or disregard, per comment.

Thanks and looking forward to your response 🙂

@StraubCreative Feel free to make any changes you'd like to tighten things up. Do whatever you feel is best. Thanks

[StraubCreative]

Latest round of CRs addressed on 5c159be.

These docs on Surveys are ready for your review @odoo/doc-review 😉

[AntoineVDV]

Feel free to merge after the comments have been resolved (approved or rejected).

@robodoo delegate+

[StraubCreative]

Addressed change requests on f2a8375

• seealso tag cleanup: removed unnecessary lists and indentations. Also removed redundant tag at the bottom of create.rst since those docs were already referenced earlier in the article.
• fixed broken guilabel tags on time_random.rst

All checks pass 🚀
@robodoo r+

[robodoo]

I'm sorry, @StraubCreative. I'm afraid I can't do that.

[StraubCreative]

I'm sorry, @StraubCreative. I'm afraid I can't do that.

@AntoineVDV robodoo being grumpy 😭

[AntoineVDV]

delegate+ delegates the review rights to the author of the PR; delegate=<someone> delegates the rights to <someone>.

@robodoo r+