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

Remove the duplicated nixops manual #26

Merged
merged 1 commit into from Mar 15, 2020

Conversation

bhipple
Copy link
Contributor

@bhipple bhipple commented Mar 15, 2020

The actual manual for NixOps, including all its plugins, is still built and
deployed from the main repo:
https://github.com/NixOS/nixops

This appears to be a potential hard-fork in the making, but the main repo does
not reference it when generating the release, so best to delete it to avoid
confusion.

It does seem like a reasonable idea to have documentation colocated with the
code it's documenting, and in the future it'd probably be a good idea to extend
the NixOps manual compilation to find and concat sections from plugins; when
that day comes we can recover the AWS specific portions from the nixops doc dir.

Resolves #19

The actual manual for NixOps, including all its plugins, is still built and
deployed from the main repo:
https://github.com/NixOS/nixops

This appears to be a potential hard-fork in the making, but the main repo does
not reference it when generating the release, so best to delete it to avoid
confusion.

It does seem like a reasonable idea to have documentation colocated with the
code it's documented, and in the future it'd probably be a good idea to extend
the NixOps manual compilation to find and concat sections from plugins; when
that day comes we can recover the AWS specific portions from the nixops doc dir.

Resolves NixOS#19
@bhipple
Copy link
Contributor Author

bhipple commented Mar 15, 2020

CC @adisbladis @AmineChikhaoui

@AmineChikhaoui
Copy link
Member

This should be ok but documentation is one of the missing things that we didn't fix properly after the plugins split. Maybe we should start with copying the AWS part of the documentation either as markdown or docbook to this repo as well in the future.
But we definitely don't need all the copied stuff from the old nixops repository.

@AmineChikhaoui AmineChikhaoui merged commit cef283e into NixOS:master Mar 15, 2020
@bhipple bhipple deleted the fix/manual-duplication branch March 15, 2020 21:32
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.

Make fails
2 participants