Skip to content

Commit

Permalink
doc: fioctl symbolic link to setup git cannot be fixed
Browse files Browse the repository at this point in the history 
Signed-off-by: Camila Macedo <camila.macedo@foundries.io>
  • Loading branch information
@camilamacedo86
camilamacedo86 committed Nov 2, 2023
1 parent b26edc1 commit 3b00dd8
Showing 1 changed file with 35 additions and 4 deletions.
39 changes: 35 additions & 4 deletions source/getting-started/install-fioctl/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -213,11 +213,42 @@ Run the following command to add the relevant entries to the Git configuration:
This is because it needs to have privileges to create a symlink in the same directory as where ``git`` is located.

.. warning::
* If for some reason the command fails with an error, the following manual steps can be taken to get the exact same result::
If the ``sudo fioctl configure-git`` command fails with an error, follow these manual steps to achieve the same result:

git config --global credential.https://source.foundries.io.username fio-oauth2
git config --global credential.https://source.foundries.io.helper fio
ln -s /usr/local/bin/fioctl /usr/bin/git-credential-fio
- Configure Git with the necessary credentials:

.. code-block:: bash
git config --global credential.https://source.foundries.io.username fio-oauth2
git config --global credential.https://source.foundries.io.helper fio
- Create the symbolic link manually. The correct path will be displayed in the `fioctl` error message and may vary depending on your operating system and Git configuration environment.

Check failure on line 225 in source/getting-started/install-fioctl/index.rst

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Fio-docs.Branding-and-names] Use 'Fioctl' instead of 'fioctl'

Raw Output:
{"message": "[Fio-docs.Branding-and-names] Use 'Fioctl' instead of 'fioctl'", "location": {"path": "source/getting-started/install-fioctl/index.rst", "range": {"start": {"line": 225, "column": 84}}}, "severity": "ERROR"}

**Example**:

.. code-block:: bash
$ sudo fioctl configure-git
Symlinking /usr/local/bin/fioctl to /opt/homebrew/bin/git-credential-fio
ERROR: symlink /usr/local/bin/fioctl /opt/homebrew/bin/git-credential-fio: file exists
In the above example, the symbolic link command would be:

.. code-block:: bash
sudo ln -sf /usr/local/bin/fioctl /usr/local/bin/git-credential-fio
However, for Linux environments, it's usually:

Check failure on line 241 in source/getting-started/install-fioctl/index.rst

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Fio-docs.Linux-trademark] 'Linux' should be marked as a trademark first time it occurs in body of text.

Raw Output:
{"message": "[Fio-docs.Linux-trademark] 'Linux' should be marked as a trademark first time it occurs in body of text.", "location": {"path": "source/getting-started/install-fioctl/index.rst", "range": {"start": {"line": 241, "column": 19}}}, "severity": "ERROR"}

Check warning on line 241 in source/getting-started/install-fioctl/index.rst

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Fio-docs.Contractions] Avoid Contractions: Use 'it is' not 'it's'.

Raw Output:
{"message": "[Fio-docs.Contractions] Avoid Contractions: Use 'it is' not 'it's'.", "location": {"path": "source/getting-started/install-fioctl/index.rst", "range": {"start": {"line": 241, "column": 39}}}, "severity": "WARNING"}

.. code-block:: bash
sudo ln -s /usr/local/bin/fioctl /usr/bin/git-credential-fio
- Configure Git to use the correct `git-credential-fio` helper by specifying its path:

.. code-block:: bash
git config --global credential.helper git config /path/to/symlinking/git-credential-fio
* Existing users reconfiguring Git access may need to remove the following lines from ``.gitconfig`` to use ``fioctl configure-git`` utility::

Expand Down

0 comments on commit 3b00dd8

Please sign in to comment.