introduction of the documentation

Motivation :

• have documentation and nixos-compose project in the same repository
• do it so that a change in one does not trigger a rebuild of the other

The addition of the documentation introduces some changes in the flake.nix and on the structure of the repository. Here the nixos-compose project got nested in the nixos-compose folder. Files pyproject.toml and poetry.lock are not anymore at the root of the repo.

Is it something wanted ?

Little addition :

• fix of a poetry bug by upgrading to a more recent version with the use of nixpkgs/nixos-22.05

Bonus question Are we keeping shell.nix since we have devShells outputs ? Which behaviours do we want in nix develop and nix shell ?

assigned to @jbleuzen

unassigned @jbleuzen

I'm not a big fan of this organization it adds IMHO, a useless directory hierarchy level for example and nix directories We can have different nix develop and nix shell versions for specific usages (doc-dev, nxc-dev ...)

added 1 commit

• 59e31cf7 - big doc commit

Compare with previous version

added 1 commit

• 58188e1e - remove unecessary file

Compare with previous version

added 1 commit

• 18e30614 - [doc] end of quick start

Compare with previous version

I just merged the documentation into master in 28a7e55b so I close this issue.

To do so I needed to completely rewrite the history of this branch to remove the changes not related to the documentation.

1. First with a bazooka command to clean most things (HEAD was the previous head commit of the docs branch: 18e30614).

git filter-branch -f --index-filter \
    'git rm -rf --cached --ignore-unmatch -- nixos-compose nixos_compose examples nix tests .pre-commit-config.yaml poetry.lock pyproject.toml flake.nix flake.lock' -- HEAD ^$(git merge-base HEAD master)

2. Then by dropping the compliance to most recent flake output schema commit with git rebase -i $(git merge-base HEAD master).
3. Then by adding the doc flake output to flake.nix (see 1ca49cbb)

Please keep unrelated changes in separated branch next time, it would have made the integration of the changes much easier

closed