documentation [IMP] surveys:update get started docs

Jul 29 '22 19:07 ksc-odoo

Jul 29 '22 19:07 robodoo

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!

Jul 29 '22 19:07 ksc-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!

Aug 31 '22 22:08 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.

Oct 12 '22 00:10 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

Dec 07 '22 19:12 mivu-odoo

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!

Dec 10 '22 02:12 StraubCreative