[Doc] Add venv for Ubuntu 24.04

[adarshan-intel]

Description of the changes

• This PR is a temporary workaround for gsc build fails for any distro workload on a Ubuntu 24.04 host system #202 and should be removed once the fix is upstreamed in the apt repo of Ubuntu 24.04

---

This change is 

[dimakuv]

Reviewed 1 of 1 files at r1, all commit messages.
Reviewable status: all files reviewed, 2 unresolved discussions, not enough approvals from maintainers (3 more required), not enough approvals from different teams (2 more required, approved so far: ) (waiting on @adarshan-intel)

---

-- commits line 2 at r1:

[Docs] Add venv workaround for Ubuntu 24.04

Ubuntu 24.04 has a bug that prevents running GSC out-of-the-box, see
https://bugs.launchpad.net/ubuntu/+source/python-docker/+bug/2065348

Until this bug is fixed, users must prepare venv for GSC. Describe this.

---

Documentation/index.rst line 57 at r1 (raw file):

   pip3 install docker jinja2 tomli tomli-w pyyaml

On Ubuntu 24.04 (and any recent distro compliant with PEP 668) use Python virtual

This should be slightly different:

Python venv workaround for Ubuntu 24.04
---------------------------------------

Unfortunately, Ubuntu 24.04 (noble) has a `bug that prevents out-of-the-box
execution of
GSC<https://bugs.launchpad.net/ubuntu/+source/python-docker/+bug/2065348>`__.

Until this bug is fixed, GSC must be run on Ubuntu 24.04 via Python virtual
environment (venv). Please perform the following steps to install and activate
venv for GSC:

.. code-block:: sh

   sudo apt-get install python3-venv
   python3 -m venv my_venv && source my_venv/bin/activate
   pip3 install 'docker>=6.1.0' jinja2 tomli tomli-w pyyaml

Now you can execute GSC commands (`gsc build`, `gsc sign`, etc.) as usual,
within the virtual environment confines.

[adarshan-intel]

Reviewable status: 0 of 1 files reviewed, 2 unresolved discussions, not enough approvals from maintainers (3 more required), not enough approvals from different teams (2 more required, approved so far: ), "fixup! " found in commit messages' one-liners (waiting on @dimakuv)

---

-- commits line 2 at r1:

Previously, dimakuv (Dmitrii Kuvaiskii) wrote…

[Docs] Add venv workaround for Ubuntu 24.04

Ubuntu 24.04 has a bug that prevents running GSC out-of-the-box, see
https://bugs.launchpad.net/ubuntu/+source/python-docker/+bug/2065348

Until this bug is fixed, users must prepare venv for GSC. Describe this.

Done.

---

Documentation/index.rst line 57 at r1 (raw file):

Previously, dimakuv (Dmitrii Kuvaiskii) wrote…

This should be slightly different:

Python venv workaround for Ubuntu 24.04
---------------------------------------

Unfortunately, Ubuntu 24.04 (noble) has a `bug that prevents out-of-the-box
execution of
GSC<https://bugs.launchpad.net/ubuntu/+source/python-docker/+bug/2065348>`__.

Until this bug is fixed, GSC must be run on Ubuntu 24.04 via Python virtual
environment (venv). Please perform the following steps to install and activate
venv for GSC:

.. code-block:: sh

   sudo apt-get install python3-venv
   python3 -m venv my_venv && source my_venv/bin/activate
   pip3 install 'docker>=6.1.0' jinja2 tomli tomli-w pyyaml

Now you can execute GSC commands (`gsc build`, `gsc sign`, etc.) as usual,
within the virtual environment confines.

Done.

[kailun-qin]

Reviewed 1 of 1 files at r2, all commit messages.
Reviewable status: all files reviewed, 3 unresolved discussions, not enough approvals from maintainers (3 more required), not enough approvals from different teams (2 more required, approved so far: ), "fixup! " found in commit messages' one-liners (waiting on @adarshan-intel and @dimakuv)

---

Documentation/index.rst line 62 at r2 (raw file):

Unfortunately, Ubuntu 24.04 (noble) has a `bug that prevents out-of-the-box
execution of
GSC<https://bugs.launchpad.net/ubuntu/+source/python-docker/+bug/2065348>`__.

I think a space is needed here -> GSC <

Code quote:

GSC<

[adarshan-intel]

Reviewable status: 0 of 1 files reviewed, 3 unresolved discussions, not enough approvals from maintainers (3 more required), not enough approvals from different teams (2 more required, approved so far: ), "fixup! " found in commit messages' one-liners (waiting on @dimakuv and @kailun-qin)

---

Documentation/index.rst line 62 at r2 (raw file):

Previously, kailun-qin (Kailun Qin) wrote…

I think a space is needed here -> GSC <

Done.

[dimakuv]

Reviewed 1 of 1 files at r3, all commit messages.
Reviewable status: all files reviewed, 1 unresolved discussion, not enough approvals from maintainers (3 more required), not enough approvals from different teams (2 more required, approved so far: ), "fixup! " found in commit messages' one-liners (waiting on @kailun-qin)

---

Documentation/index.rst line 62 at r2 (raw file):

Previously, adarshan-intel (Adarsh Anand) wrote…

Done.

No, the space is not needed, as this is the hyperlink syntax of RestructuredText. Please revert this change (or explain to me why this is necessary).

[adarshan-intel]

Reviewable status: all files reviewed, 1 unresolved discussion, not enough approvals from maintainers (3 more required), not enough approvals from different teams (2 more required, approved so far: ), "fixup! " found in commit messages' one-liners (waiting on @dimakuv and @kailun-qin)

---

Documentation/index.rst line 62 at r2 (raw file):

Previously, dimakuv (Dmitrii Kuvaiskii) wrote…

No, the space is not needed, as this is the hyperlink syntax of RestructuredText. Please revert this change (or explain to me why this is necessary).

Done.

[dimakuv]

Reviewed 1 of 1 files at r4, all commit messages.
Reviewable status: all files reviewed, 1 unresolved discussion, not enough approvals from maintainers (2 more required), not enough approvals from different teams (1 more required, approved so far: Intel), "fixup! " found in commit messages' one-liners (waiting on @kailun-qin)

[dimakuv]

Reviewable status: all files reviewed, 1 unresolved discussion, not enough approvals from maintainers (3 more required), not enough approvals from different teams (2 more required, approved so far: ), "fixup! " found in commit messages' one-liners (waiting on @kailun-qin)

---

Documentation/index.rst line 62 at r2 (raw file):

Previously, adarshan-intel (Adarsh Anand) wrote…

Done.

I was wrong, sorry: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#hyperlinks

Indeed, there needs to be a space after GSC... Sorry, please do it again, as Kailun requested.

[adarshan-intel]

Reviewable status: all files reviewed, 1 unresolved discussion, not enough approvals from maintainers (3 more required), not enough approvals from different teams (2 more required, approved so far: ), "fixup! " found in commit messages' one-liners (waiting on @kailun-qin)

---

Documentation/index.rst line 62 at r2 (raw file):

Previously, dimakuv (Dmitrii Kuvaiskii) wrote…

I was wrong, sorry: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#hyperlinks

Indeed, there needs to be a space after GSC... Sorry, please do it again, as Kailun requested.

Done.

[dimakuv]

Reviewed 1 of 1 files at r5, all commit messages.
Reviewable status: all files reviewed, 1 unresolved discussion, not enough approvals from maintainers (2 more required), not enough approvals from different teams (1 more required, approved so far: Intel), "fixup! " found in commit messages' one-liners (waiting on @kailun-qin)

[kailun-qin]

Reviewed 1 of 1 files at r5, all commit messages.
Reviewable status: all files reviewed, all discussions resolved, not enough approvals from maintainers (1 more required), not enough approvals from different teams (1 more required, approved so far: Intel), "fixup! " found in commit messages' one-liners

[adarshan-intel]

@woju Please review this PR.

[woju]

Reviewed 1 of 1 files at r5, all commit messages.
Reviewable status: all files reviewed, all discussions resolved, "fixup! " found in commit messages' one-liners

[dimakuv]

Reviewable status: all files reviewed, all discussions resolved, "fixup! " found in commit messages' one-liners

[dimakuv]

Reviewed 1 of 1 files at r6, all commit messages.
Reviewable status: complete! all files reviewed, all discussions resolved

[woju]

Reviewed 1 of 1 files at r6, all commit messages.
Reviewable status: complete! all files reviewed, all discussions resolved