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 section "Add relevant documentation" to contributing guidelines in the manual #1306

Conversation

DamienCassou
Copy link
Contributor

Description

  • adds a section "Add relevant documentation" to contributing guidelines in the manual. This should help the contributor check changes to the documentation
  • adds "html-manual" and "manPages" attributes to default.nix.

Checklist

  • Change is backwards compatible.
  • Code formatted with ./format.
  • Commit messages are formatted like

Add html-manual and manPages to default.nix. These attributes provide
an easy way to check changes to the documentation before sending a
Pull Request.
@DamienCassou DamienCassou requested a review from rycee as a code owner June 6, 2020 20:16
@Kloenk
Copy link
Member

Kloenk commented Jun 6, 2020

Are those the docs build with nmd? Maybe we could use this to fix the usage of nmd? (it breaks hydra and some evaluators because of import-from-derivation)

@DamienCassou DamienCassou changed the title Damien/add relevant documentation Add section "Add relevant documentation" to contributing guidelines in the manual Jun 7, 2020
@DamienCassou
Copy link
Contributor Author

Are those the docs build with nmd?

I think so

Maybe we could use this to fix the usage of nmd?

I don't know what you are talking about. Is there anything I should do?

@Kloenk
Copy link
Member

Kloenk commented Jun 7, 2020

Maybe we could use this to fix the usage of nmd?

I don't know what you are talking about. Is there anything I should do?

I had to deactivate the home-manager docs in my system, because I'm unable to evaluate my systems if I have them enabled. The problem is with import-from-derivation, where I'm unable to see how many builds I'm doing at the end (hydra breaks).

@DamienCassou
Copy link
Contributor Author

What is the relation between what you are talking about and what I did?

rycee pushed a commit that referenced this pull request Jun 11, 2020
This adds a new section to the contributing guidelines that discusses
how contributions should be documented.

PR #1306
@rycee
Copy link
Member

rycee commented Jun 11, 2020

Thanks, I think this was a really good idea! I've made some minor edits and rebased to master in 4ba9ced.

@rycee rycee closed this Jun 11, 2020
@DamienCassou DamienCassou deleted the damien/add-relevant-documentation branch June 12, 2020 07:17
colemickens pushed a commit to colemickens/home-manager that referenced this pull request Jun 24, 2020
This adds a new section to the contributing guidelines that discusses
how contributions should be documented.

PR nix-community#1306
colemickens pushed a commit to colemickens/home-manager that referenced this pull request Jun 27, 2020
This adds a new section to the contributing guidelines that discusses
how contributions should be documented.

PR nix-community#1306
colemickens pushed a commit to colemickens/home-manager that referenced this pull request Jul 20, 2020
This adds a new section to the contributing guidelines that discusses
how contributions should be documented.

PR nix-community#1306
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

3 participants