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 wiki-js recipe #815

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Add wiki-js recipe #815

wants to merge 2 commits into from

Conversation

drupol
Copy link
Contributor

@drupol drupol commented Nov 28, 2023

Hi,

This is my first PR in this project.

Let me know if:

  1. Such thing is the right place
  2. If it worth adding it here
  3. If it worth it, should I change anything?

@drupol drupol force-pushed the patch-2 branch 4 times, most recently from 793a572 to adb0888 Compare November 28, 2023 10:52
@fricklerhandwerk
Copy link
Collaborator

@drupol thanks for the PR! I think generally it's a great idea to present such example setups. Yours is particularly well-written in my opinion.

Your proposal prompts the @NixOS/documentation-team to finally think in all seriousness about how to deal with those more generally. We've briefly discussed it before, but came to no conclusion because there were more pressing issues.

Here are some considerations:

  • Here on nix.dev such samples will eventually go stale, it would in principle be better to keep them next to the code (same problem as with Wikis in general)
  • There are no conventions or infrastructure to accommodate this in Nixpkgs. The closest seems to be pkgs/by-name, but there is currently no pattern to handle modules.
    • I can imagine your text to be in the README.md of the package's directory, and it would be a good example to build upon. It would mean though, that for a while no one will be able to find it because there are no hints and facilities for this.
  • We can merge it as is, just to have a place for it now, but it will just postpone systematically dealing with a question I think is important already in the mid-term

@infinisil
Copy link
Member

I generally think that NixOS modules should ideally Just Work™ with enable = true. Could the wiki-js module be made to work that way too?

@drupol
Copy link
Contributor Author

drupol commented Nov 28, 2023

@fricklerhandwerk: I've developed a recipe that I believe could be beneficial to others in our community. Initially, I considered sharing it on https://nixos.wiki, but given that it's not an official platform, I'd prefer to centralize the documentation in a more official location. This led to my decision to submit a PR here. I'm open to suggestions on the best place to share this information. Once I have your guidance, I'll make the necessary adjustments to ensure it's posted in the most appropriate place.

@infinisil: It seems that the feature isn't currently enabled (nixos/module). I agree that activating it would be interesting. I'm willing to explore this further and will look into what can be done to implement this idea.

Copy link
Contributor

@henrik-ch henrik-ch left a comment

Choose a reason for hiding this comment

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

LGTM, only small nitpick.

source/guides/recipes/wiki-js.md Outdated Show resolved Hide resolved
Co-authored-by: Henrik <i97henka@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants