Browse Source

Update documentation after final release review

master
Peter J. Jones 2 years ago
parent
commit
8f2eb540d7
Signed by: Peter Jones <pjones@devalot.com> GPG Key ID: 9DAFAA8D01941E49
6 changed files with 89 additions and 19 deletions
  1. 0
    2
      CHANGES.md
  2. 83
    0
      MAINTAINERS.md
  3. 4
    2
      README.md
  4. 0
    14
      TODO
  5. 1
    0
      cabal.project
  6. 1
    1
      xmonad.cabal

+ 0
- 2
CHANGES.md View File

@@ -69,8 +69,6 @@
69 69
     Fixes #8.  (Second way to have a custom build environment for
70 70
     XMonad.  See previous entry for another solution.)
71 71
 
72
-  * Fixed a crash related to an unhandled getWindowAttributes exception
73
-
74 72
 ## 0.12 (December 14, 2015)
75 73
 
76 74
   * Compiles with GHC 7.10.2, 7.8.4, and 7.6.3

+ 83
- 0
MAINTAINERS.md View File

@@ -0,0 +1,83 @@
1
+# XMonad Maintainers
2
+
3
+## The XMonad Core Team
4
+
5
+  * Adam Vogt [GitHub][aavogt]
6
+
7
+  * Brandon S Allbery [GitHub][geekosaur], IRC: `geekosaur`
8
+
9
+  * Brent Yorgey [GitHub][byorgey], IRC: `byorgey`
10
+
11
+  * Daniel Wagner [GitHub][dmwit], IRC: `dmwit`
12
+
13
+  * David Lazar [GitHub][davidlazar]
14
+
15
+  * Devin Mullins [GitHub][twifkak]
16
+
17
+  * Peter J. Jones [GitHub][pjones], [Twitter][twitter:pjones], [OpenPGP Key][pgp:pjones], IRC: `pmade`
18
+
19
+## Release Procedures
20
+
21
+When the time comes to release another version of XMonad and Contrib...
22
+
23
+  1. Create a release branch (e.g., `release-0.XX`).
24
+
25
+     This will allow you to separate the release process from main
26
+     development.  Changes you make on this branch will be merged back
27
+     into `master` as one of the last steps.
28
+
29
+  2. Update the version number in the `*.cabal` files and verify
30
+     dependencies and documentation.  This includes the `tested-with:`
31
+     field.
32
+
33
+  3. Use the [packdeps][] tool to ensure you have the dependency
34
+     versions correct.  If you need to update the version of a
35
+     dependency then you should rebuild and retest.
36
+
37
+  4. Review documentation files and make sure they are accurate:
38
+
39
+     - `README.md`
40
+     - `CHANGES.md`
41
+     - and the `example-config.hs` in the `xmonad-testing` repo
42
+
43
+  5. Generate the manpage:
44
+
45
+     * `cabal configure` with the `-fgeneratemanpage` flag
46
+     * Build the project
47
+     * Run the `generatemanpage` tool from the top level of this repo
48
+     * Review the man page: `man -l man/xmonad.1`
49
+
50
+  6. Tag the repository with the release version (e.g., `v0.13`)
51
+
52
+  7. Build the project tarballs (`cabal sdist`)
53
+
54
+  8. Upload the packages to Hackage (`cabal upload`)
55
+
56
+  9. Merge the release branches into `master`
57
+
58
+  10. Update the website:
59
+
60
+      * Generate and push haddocks with `xmonad-web/gen-docs.sh`
61
+
62
+      * Check that `tour.html` and `intro.html` are up to date, and
63
+        mention all core bindings
64
+
65
+  11. Update the topic for the IRC channel (`#xmonad`)
66
+
67
+  12. Send the `announce-0.XX.txt` file to:
68
+
69
+      - XMonad mailing list
70
+      - Haskell Cafe
71
+
72
+[packdeps]: http://hackage.haskell.org/package/packdeps
73
+
74
+[aavogt]: https://github.com/orgs/xmonad/people/aavogt
75
+[geekosaur]: https://github.com/orgs/xmonad/people/geekosaur
76
+[byorgey]: https://github.com/orgs/xmonad/people/byorgey
77
+[dmwit]: https://github.com/orgs/xmonad/people/dmwit
78
+[davidlazar]: https://github.com/orgs/xmonad/people/davidlazar
79
+[twifkak]: https://github.com/orgs/xmonad/people/twifkak
80
+
81
+[pjones]: https://github.com/orgs/xmonad/people/pjones
82
+[twitter:pjones]: https://twitter.com/contextualdev
83
+[pgp:pjones]: http://pgp.mit.edu/pks/lookup?op=get&search=0x526722D1204284CB

+ 4
- 2
README.md View File

@@ -64,7 +64,7 @@ We'll now walk through the complete list of toolchain dependencies.
64 64
 
65 65
 ## Running xmonad
66 66
 
67
-Add:
67
+If you built XMonad using `cabal` then add:
68 68
 
69 69
     exec $HOME/.cabal/bin/xmonad
70 70
 
@@ -72,7 +72,7 @@ to the last line of your `.xsession` or `.xinitrc` file.
72 72
 
73 73
 ## Configuring
74 74
 
75
-See the `CONFIG` document.
75
+See the [CONFIG][] document and the [example configuration file][example-config].
76 76
 
77 77
 ## XMonadContrib
78 78
 
@@ -117,3 +117,5 @@ For a program dispatch menu:
117 117
 [xmonadcontrib]: https://hackage.haskell.org/package/xmonad-contrib
118 118
 [xmc-prompt-shell]: https://hackage.haskell.org/package/xmonad-contrib/docs/XMonad-Prompt-Shell.html
119 119
 [platform]: http://haskell.org/platform/
120
+[example-config]: https://github.com/xmonad/xmonad-testing/blob/master/example-config.hs
121
+[config]: https://github.com/xmonad/xmonad/blob/master/CONFIG

+ 0
- 14
TODO View File

@@ -1,14 +0,0 @@
1
-= Release management =
2
-
3
-* generate, and push website haddocks with xmonad-web/gen-docs.sh
4
-* generate manpage, generate html manpage
5
-* double check README build instructions
6
-* bump xmonad.cabal version and X11 version
7
-* update cabal "tested-with:" fields
8
-* upload X11 and xmonad to Hackage
9
-* update #xmonad topic
10
-* check examples/text in user-facing Config.hs
11
-* check tour.html and intro.html are up to date, and mention all core bindings
12
-* confirm template config is type correct
13
-* update haskellwiki notable changes since x.x
14
-* email announce

+ 1
- 0
cabal.project View File

@@ -0,0 +1 @@
1
+packages: ./

+ 1
- 1
xmonad.cabal View File

@@ -17,7 +17,7 @@ license:            BSD3
17 17
 license-file:       LICENSE
18 18
 author:             Spencer Janssen
19 19
 maintainer:         xmonad@haskell.org
20
-extra-source-files: README.md CHANGES.md TODO CONFIG STYLE
20
+extra-source-files: README.md CHANGES.md CONFIG STYLE
21 21
                     tests/*.hs
22 22
                     tests/Properties/*.hs
23 23
                     tests/Properties/Layout/*.hs

Loading…
Cancel
Save