doc: fioctl symbolic link to setup git cannot be fixed

[camilamacedo86]

Signed-off-by: Camila Macedo [email protected]

Readiness

• Merge (pending reviews)
• Merge after date or event
• Draft

Overview

Why merge this PR? What does it solve?

Checklist

Optional. Add a 'x' to steps taken.
You can fill this out after opening the PR. "Did I..."

• Run spelling and grammar check, preferably with linter.
• Avoid changing any header associated with a link/reference.
• Step through instructions (or ask someone to do so).
• Review for wordiness
• Match tone and style of page/section.
• Run make linkcheck.
• View HTML in a browser to check rendering.
• Use semantic newlines.
• follow best practices for commits.
  • Descriptive title written in the imperative.
  • Include brief overview of QA steps taken.
  • Mention any related issues numbers.
  • End message with sign off/DCO line (-s, --signoff).
  • Sign commit with your gpg key (-S, --gpg-sign).
  • Squash commits if needed.
• Request PR review by a technical writer and at least one peer.

Comments

Any thing else that a maintainer/reviewer should know.
This could include potential issues, rational for approach, etc.

[doanac]

Docs for 13f17d1 are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2459/docs/artifacts/html/index.html

[doanac]

Docs for 37ea804 are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2461/docs/artifacts/html/index.html

[doanac]

Docs for 8ca5881 are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2462/docs/artifacts/html/index.html

[angolini]

For me, the warning box is too big. And the box's content is more like a tip than a warning (I prefer to use warning to say that a command can brick a board, for example).

I don't know how is the FAQ linking strategy we've been using (I've never made a FAQ). Let's see what @kprosise say about this.

Other this points, I'm OK with the PR, and if we decide to keep this as is I'm also OK

[doanac]

Docs for 04bca2d are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2473/docs/artifacts/html/index.html

[camilamacedo86]

Hi @angolini and @kprosise

I've taken care of the suggestions made now.
Please feel free to check them out.

Thank you for your attention and time.

[kprosise]

LGTM!

[vanmaegima]

I didn't like this warning (previous one) but we needed at some time when we changed to setting up git with fioctl. My idea was to remove it once fioctl git setting was stable. @camilamacedo86 did you have any issues with that and needed to run the manual steps recently?

[camilamacedo86]

Yes, I encountered issues. They may occur depending on the environment and specific Git configurations.
The manual steps are really important. Indeed for MEDs

Note that they were here already. The problem that I am trying to address is that the current instructions say for us to create a symbolic link for a specific path (default linux one) when it might not be accurate. For example, the path in the Mac will depends on if you are using homebrew and etc.

[doanac]

Docs for f1a84d1 are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2474/docs/artifacts/html/index.html

[doanac]

Docs for ff160cc are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2475/docs/artifacts/html/index.html