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

nixos/doc/releases: update the docs as promised #86368

Merged
merged 3 commits into from Sep 4, 2020

Conversation

@worldofpeace
Copy link
Member

@worldofpeace worldofpeace commented Apr 30, 2020

This goes through a recent example of 19.09 (because the workflow
should be everchanging, so our example needs to be recent).
Lots of changes, just read idk.

Motivation for this change

Ok, so don't judge me but I converted releases.xml to markdown with pandoc, edited it, then used pandoc to convert it back, edited it. (and then some xmlformat).
Probably not perfect, but the manual builds.

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.
@worldofpeace
Copy link
Member Author

@worldofpeace worldofpeace commented Apr 30, 2020

cc @cole-h
(though, remember the slight level of delirium)

nixos/doc/manual/development/releases.xml Outdated Show resolved Hide resolved
nixos/doc/manual/development/releases.xml Outdated Show resolved Hide resolved
nixos/doc/manual/development/releases.xml Outdated Show resolved Hide resolved
nixos/doc/manual/development/releases.xml Outdated Show resolved Hide resolved
nixos/doc/manual/development/releases.xml Outdated Show resolved Hide resolved
nixos/doc/manual/development/releases.xml Outdated Show resolved Hide resolved
<para>
decide which bug fixes, features, etc… get backported after a release
</para>
</listitem>
</itemizedlist>
</section>
<section xml:id="release-schedule">

This comment has been minimized.

@cole-h

cole-h Apr 30, 2020
Member

Out of view from here, but maybe the release schedule should be updated or something, since it still refers to the nix-dev mailing list which, to the best of my knowledge, is dead? (Or at least under-used to the point of me not having used/read it in my 3 months here...)

This comment has been minimized.

@worldofpeace

worldofpeace Apr 30, 2020
Author Member

Sure, I probably should do this in this PR.

nixos/doc/manual/development/releases.xml Outdated Show resolved Hide resolved
</listitem>
<listitem>
<para>
<link xlink:href="https://github.com/NixOS/nixos-homepage/blob/a5626c71c03a2dd69086564e56f1a230a2bb177a/logo/nixos-logo-19.09-loris-lores.png">Add a compressed version of the NixOS logo for 19.09</link>.

This comment has been minimized.

@cole-h

cole-h Apr 30, 2020
Member

IIRC, this was just some convert magic -- could this be documented? (I don't know who actually does this, but I imagine you do.)

This comment has been minimized.

@worldofpeace

worldofpeace Apr 30, 2020
Author Member

@garbas Do you recall the exact command you did to get the correct width?

@cole-h @garbas was kind enough to handle that task for me 😄

This comment has been minimized.

@garbas

garbas May 6, 2020
Contributor

I think I just used gimp. but we probably want convert command for this.

I hope soon to start conversation in marketing team about next release process and where we can help out. I think writing announcement and handling artwork could be done by marketing and then reviewed / signed off by release manager.

This goes through a recent example of 19.09 (because the workflow
should be everchanging, so our example needs to be recent).
Lots of changes, just read idk.
@worldofpeace worldofpeace force-pushed the worldofpeace:update-rm-docs branch from 4484f8f to 4ea275d Aug 15, 2020
@worldofpeace
Copy link
Member Author

@worldofpeace worldofpeace commented Aug 15, 2020

I just need to fix #86368 (comment), but by what time it is currently I don't think I have the required synapses firing in order to format proper docbook.

@jtojnar
Copy link
Contributor

@jtojnar jtojnar commented Aug 16, 2020

FTFY, along with code blocks being outside of the list items and lists being broken. Also changed the chapter 4 reference to <xref>.

Discuss with Eelco Dolstra and the community (via IRC, ML) about what
will reach the deadline. Any issue or Pull Request targeting the release
should be included in the release milestone.
Discuss with Eelco Dolstra and the community (via IRC, ML) about what will reach the deadline. Any issue or Pull Request targeting the release should be included in the release milestone.

This comment has been minimized.

@jtojnar

jtojnar Aug 16, 2020
Contributor

via IRC, ML

We no longer use mailing list. Currently it is being discussed on an issue #95475

This comment has been minimized.

@worldofpeace

worldofpeace Aug 17, 2020
Author Member

Thx, I think in a followup I'm going to change this.

@worldofpeace
Copy link
Member Author

@worldofpeace worldofpeace commented Aug 17, 2020

omg @jtojnar thank u. That totally saveeed me.

@jtojnar
Copy link
Contributor

@jtojnar jtojnar commented Aug 17, 2020

Yesterday, I also packaged XMLmind XML Editor #95593 which should help you edit existing DocBook documents without having to wrangle the elements manually.

@worldofpeace
Copy link
Member Author

@worldofpeace worldofpeace commented Aug 20, 2020

Yesterday, I also packaged XMLmind XML Editor #95593 which should help you edit existing DocBook documents without having to wrangle the elements manually.

Ooohh cooool

@worldofpeace
Copy link
Member Author

@worldofpeace worldofpeace commented Aug 20, 2020

Going to try it out

Copy link
Contributor

@jonringer jonringer left a comment

I was able to build the manual with these changes.

I'll iterate on them in a new PR.

Thanks @worldofpeace :)

@jonringer jonringer merged commit 951efe4 into NixOS:master Sep 4, 2020
14 checks passed
14 checks passed
Evaluation Performance Report Evaluator Performance Report
Details
grahamcofborg-eval ^.^!
Details
grahamcofborg-eval-check-maintainers matching changed paths to changed attrs...
Details
grahamcofborg-eval-check-meta config.nix: checkMeta = true
Details
grahamcofborg-eval-darwin nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="366fe0b"; rev="366fe0b700cd9c66c2622394157532ece64731a3"; } ./pkgs/t
Details
grahamcofborg-eval-lib-tests nix-build --arg pkgs import ./. {} ./lib/tests/release.nix
Details
grahamcofborg-eval-nixos nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="366fe0b"; rev="366fe0b700cd9c66c2622394157532ece64731a3"; } ./nixos/
Details
grahamcofborg-eval-nixos-manual nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="366fe0b"; rev="366fe0b700cd9c66c2622394157532ece64731a3"; } ./nixos/
Details
grahamcofborg-eval-nixos-options nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="366fe0b"; rev="366fe0b700cd9c66c2622394157532ece64731a3"; } ./nixos/
Details
grahamcofborg-eval-nixpkgs-manual nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="366fe0b"; rev="366fe0b700cd9c66c2622394157532ece64731a3"; } ./pkgs/t
Details
grahamcofborg-eval-nixpkgs-tarball nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="366fe0b"; rev="366fe0b700cd9c66c2622394157532ece64731a3"; } ./pkgs/t
Details
grahamcofborg-eval-nixpkgs-unstable-jobset nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="366fe0b"; rev="366fe0b700cd9c66c2622394157532ece64731a3"; } ./pkgs/t
Details
grahamcofborg-eval-package-list nix-env -qa --json --file .
Details
grahamcofborg-eval-package-list-no-aliases nix-env -qa --json --file . --arg config { allowAliases = false; }
Details
@worldofpeace worldofpeace deleted the worldofpeace:update-rm-docs branch Sep 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

5 participants
You can’t perform that action at this time.