Flox environment

[sebastian-luna-valero]

Summary

The "version" of docsy that we use is generating the issue described in #639 with the latest versions of hugo. According to my tests the latest working version of hugo is v0.110.0.

In addition to specifying the latest working version of hugo in the docs to contribute, I am also adding an environment with flox. See also related discussion in #637.

Merging this PR fixes #639. However, we may also want to discuss whether to migrate docsy from git submodules to hugo modules so the latest version of both hugo and docsy can be used.

---

Related issue : #639

[gwarf]

Flox is new to me, AFAICS it seems to built on Nix in some way and easing usage? Looks interesting.

I've been using nix/nixos/nix-darwin/home-manager for some time to manage my local dev environments, dotfiles and OS configurations, it was working quite great.
For the record, and as we never speak enough about politics ^^ , I lately totally moved away from nix, both because nix language wasn't that straightforward to me, and due to governance issues (see https://xeiaso.net/blog/2024/much-ado-about-nothing/ and NixOS/nixpkgs#306702 as an example). The number of open issues and PR to the nixpkgs repo was also a bit frightening from a security point of view...: https://github.com/nixOS/nixpkgs (for our usage, a static website hosted by a third party, it's not really an issue).

That said I've not built the documentation repository locally since quite some time, I don't really feel I should be especially responsible for it and in case it can help I'm fine with every suggestion.

We should probably just be sure that it's also aligned with the automatic building via the GitHub Actions, so that the results are the same, including using the same Hugo versions.

The GitHub Actions are currently using a pinned version, see https://github.com/EGI-Federation/documentation/blob/2a27cf0e314a54c0abe4766f79bd7c838d96355e/.github/workflows/hugo_version.txt, it's loaded by the actions-hugo, cf

documentation/.github/workflows/deploy.yml

Lines 27 to 37 in 2a27cf0

	- name: Get Hugo version
	id: hugo_version
	uses: juliangruber/read-file-action@v1
	with:
	path: .github/workflows/hugo_version.txt
	- name: Setup Hugo
	uses: peaceiris/actions-hugo@v3
	with:
	hugo-version: "${{ steps.hugo_version.outputs.content }}"
	extended: true

So documentation and what is used to built in GA should be all aligned

[sebastian-luna-valero]

Thanks for your feedback @gwarf

Having both the manual and automated way of creating the environment should help overcome potential disruptions with flox in the future.

[sebastian-luna-valero]

By the way, I am not paying attention to the spelling issues as they are all coming from the config files.

[github-actions]

Documentation preview deployed!

Available at https://docs.egi.eu/documentation/668

[gwarf]

Thanks, so the doc site seems to build fine with the new version: https://docs.egi.eu/documentation/668/about/contributing/git/#reuse-the-flox-environment-optional

Currently, the flox stuff is a subsection to the installing dep manually, while I think it's more an alternative.
So maybe it can be clarified in the requirements section that people can either installing the dependencies manually or use the flox environment. And adjusting the headers level so that it's more logical.

[github-actions]

Documentation preview deployed!

Available at https://docs.egi.eu/documentation/668

[github-actions]

Documentation preview deployed!

Available at https://docs.egi.eu/documentation/668

[github-actions]

@check-spelling-bot Report

🔴 Please review

See the 📂 files view, the 📜action log, or 📝 job summary for details.

Unrecognized words (6)

aarch
gettin
linux
postgres
sourced
venv

To accept these unrecognized words as correct, you could run the following commands

... in a clone of the [email protected]:EGI-Federation/documentation.git repository
on the flox branch (ℹ️ how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/main/apply.pl' |
perl - 'https://github.com/EGI-Federation/documentation/actions/runs/10599173978/attempts/1'

OR

To have the bot accept them for you, reply quoting the following line:
@check-spelling-bot apply updates.

Available 📚 dictionaries could cover words (expected and unrecognized) not in the 📘 dictionary

This includes both expected items (26) from .github/actions/spelling/expect.txt and unrecognized words (6)

Dictionary	Entries	Covers	Uniquely
cspell:npm/dict/npm.txt	302	2	1
cspell:scala/dict/scala.txt	153	2
cspell:filetypes/filetypes.txt	264	2
cspell:node/dict/node.txt	891	2
cspell:cpp/src/compiler-clang-attributes.txt	46	1	1

Consider adding them (in .github/workflows/spelling.yml) for uses: check-spelling/check-spelling@main in its with:

      with:
        extra_dictionaries:
          cspell:npm/dict/npm.txt
          cspell:scala/dict/scala.txt
          cspell:filetypes/filetypes.txt
          cspell:node/dict/node.txt
          cspell:cpp/src/compiler-clang-attributes.txt

To stop checking additional dictionaries, add (in .github/workflows/spelling.yml) for uses: check-spelling/check-spelling@main in its with:

check_extra_dictionaries: ''

[github-actions]

Documentation preview deployed!

Available at https://docs.egi.eu/documentation/668

[gwarf]

LGTM, thanks!