Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a fuel.nix mdbook #61

Merged
merged 20 commits into from Jun 2, 2023
Merged

Add a fuel.nix mdbook #61

merged 20 commits into from Jun 2, 2023

Conversation

mitchmindtree
Copy link
Contributor

@mitchmindtree mitchmindtree commented May 24, 2023

This adds a new book/ directory containing an mdbook for fuel.nix.

The new book will replace the README with a much friendlier "Quick Start", and a more searchable and detailed guide covering how to install Nix, use fuel packages, and how to contribute to fuel.nix itself.

Closes #59.

TODO

  • Add a new "Quick Start" section with the new two-step installation approach.
  • Merge existing README content into subchapters.
  • Add a more detailed "Nix Setup" chapter for those interested in more details.
  • Add a section on nix profile install for persistent installation to the "Packages" chapter.
  • Add a new "Contributing" section with details on how to add/update packages and milestones.
  • Update the README to simply point to the book and Quick Start.
  • Add a CI step to publish the book.
  • Open an issue to remove the NOTE: under the nix profile install section required due to After removing 0.8.0 and installing 0.9.0, many nix profile commands fail DeterminateSystems/nix-installer#477. It seems this issue only occurs if a previous Nix installation existed but was not cleaned up properly. The note has been updated.

@mitchmindtree mitchmindtree added the enhancement New feature or request label May 24, 2023
@mitchmindtree mitchmindtree self-assigned this May 24, 2023
@mitchmindtree mitchmindtree force-pushed the mitchmindtree/book branch 4 times, most recently from 4547097 to ff2cf2a Compare May 30, 2023 08:27
@mitchmindtree mitchmindtree added the documentation Improvements or additions to documentation label May 30, 2023
@mitchmindtree
Copy link
Contributor Author

This is just about ready to go, however it seems like the recent addition of the sysinfo crate in Sway and forc for benchmarking may have introduced some non-determinism in the macOS builds.

Today's refresh-manifests job succeeded, however the current CI macos-latest matrix job is missing the cache, and failing with a linker error.

       >   = note: Undefined symbols for architecture x86_64:
       >             "_kCFURLVolumeAvailableCapacityForImportantUsageKey", referenced from:
       >                 _$LT$sysinfo..apple..disk..Disk$u20$as$u20$sysinfo..traits..DiskExt$GT$::refresh::ha090b62f02761b2b in libsysinfo-bfbd6883445a3969.rlib(sysinfo-bfbd6883445a3969.sysinfo.4f5fc5ae-cgu.15.rcgu.o)
       >                 sysinfo::apple::disk::get_disks::h63aaac400a8fb64f in libsysinfo-bfbd6883445a3969.rlib(sysinfo-bfbd6883445a3969.sysinfo.4f5fc5ae-cgu.15.rcgu.o)
       >           ld: symbol(s) not found for architecture x86_64
       >           clang-11: error: linker command failed with exit code 1 (use -v to see invocation)
       >           
       >
       > error: could not compile `forc` due to previous error
       For full logs, run 'nix log /nix/store/vgq1zhv6q43wbgbd5hifm26ab2wikwj9-forc-0.39.1.drv'.
error: 1 dependencies of derivation '/nix/store/jfxshavhlsxkkdfnjdqpxfcyjv1icj6f-fuel-nightly.drv' failed to build

All that said, it's unclear how the latest refresh-manifests action succeeded without incurring the same linker error, or if sysinfo is definitely the cause of the cache invalidation 🤔

@mitchmindtree
Copy link
Contributor Author

It looks like the same issue was encountered in nushell NixOS/nixpkgs#214872. Apparently fixed in NixOS/nixpkgs#215782. It could be worth trying a similar patch.

@mitchmindtree
Copy link
Contributor Author

The fuel-nightly macos-latest failure appears unrelated, tracking under #64, will investigate shortly!

@mitchmindtree mitchmindtree marked this pull request as ready for review June 1, 2023 06:14
Copy link
Contributor Author

@mitchmindtree mitchmindtree left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK this should be ready to go!

I'll open a follow-up issue/PR for adding markdown linting, but want to try to address #70 first.

github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./book/book
destination_dir: ./
cname: nix.fuel.network
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Voxelot do you know what we might need to do with the fuel.network hosting to get this cname to work like we have for rust.fuel.network?

This adds a new `book/` directory containing an mdbook for `fuel.nix`.

The new book will replace the README with a much friendlier "Quick
Start", and a more searchablei and detailed guide covering how to
install Nix, use fuel packages, and how to contribute to fuel.nix
itself.

TODO
----

- [x] Add a new "Quick Start" section with the new two-step installation approach.
- [x] Merge existing README content into subchapters.
- [x] Add a more detailed "Nix Setup" chapter for those interested in more details.
- [x] Add a section on `nix profile install` for persistent installation to the "Packages" chapter.
- [ ] Add a new "Contributing" section with details on how to add/update packages and milestones.
- [ ] Update the README to simply point to the book and Quick Start.
- [ ] Add a CI step to publish the book.
- [ ] Open an issue to remove the **NOTE:** under the `nix profile install` section required due to DeterminateSystems/nix-installer#477.
@mitchmindtree
Copy link
Contributor Author

I think this should at least publish to the gh-pages branch and the github.io link for now - I'll open up a follow-up issue for the cname redirect.

@mitchmindtree mitchmindtree merged commit f91223e into master Jun 2, 2023
16 checks passed
@mitchmindtree mitchmindtree deleted the mitchmindtree/book branch June 2, 2023 07:25
mitchmindtree added a commit that referenced this pull request Jun 2, 2023
Adds the missing nix installation that provides the environment for
building the book.

Follow-up to #61
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update README to recommend the Determinate Systems nix-installer
2 participants