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

docs/search: refactor to use override #2536

Merged
merged 1 commit into from
Nov 18, 2024

Conversation

MattSturgeon
Copy link
Member

This should hopefully make branching off 24.11 easier, and may also be a step towards having additional docs versions available and/or docs linking to each other.

@MattSturgeon MattSturgeon requested a review from a team November 18, 2024 18:31
Copy link
Contributor

@khaneliman khaneliman left a comment

Choose a reason for hiding this comment

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

Looks good from my house.

@MattSturgeon
Copy link
Member Author

@mergify queue

Copy link
Contributor

mergify bot commented Nov 18, 2024

queue

✅ The pull request has been merged automatically

The pull request has been merged automatically at cdbda98

Copy link
Contributor

mergify bot commented Nov 18, 2024

This pull request, with head sha cdbda982f04bd021cfa8d549896410c5caf84fdf, has been successfully merged with fast-forward by Mergify.

This pull request will be automatically closed by GitHub.

As soon as GitHub detects that the sha cdbda982f04bd021cfa8d549896410c5caf84fdf is part of the main branch, it will mark this pull request as merged.

It is possible for this pull request to remain open if this detection does not happen, this usually happens when a force-push is done on this branch docs-search-cleanup, this means GitHub will fail to detect the merge.

@mergify mergify bot merged commit cdbda98 into nix-community:main Nov 18, 2024
4 checks passed
@MattSturgeon MattSturgeon deleted the docs-search-cleanup branch November 18, 2024 19:28
search = mkSearch "/";
search = nuschtosSearch.packages.mkSearch {
optionsJSON = options-json + "/share/doc/nixos/options.json";
urlPrefix = "https://github.com/nix-community/nixvim/tree/main";
Copy link
Member

Choose a reason for hiding this comment

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

We should maybe the github URL overrideable too?

Copy link
Member Author

Choose a reason for hiding this comment

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

I wonder if that is best done by CI, or by having a version.json file? 🤔

Copy link
Member

@traxys traxys Nov 18, 2024

Choose a reason for hiding this comment

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

I'd say doing it in the CI workflow, as we already have an override. I don't think we expect to build the stable docs outside CI

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm more thinking of end-users who may wish to build the docs locally themselves.

Or if we want to locally build them to test out a backport or whatever.

But sure, it's not too important to get perfect straight away

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.

3 participants