mbox series

[0/3] mdadm: Add .md doc files

Message ID 20240326122112.25552-1-mariusz.tkaczyk@linux.intel.com (mailing list archive)
Headers show
Series mdadm: Add .md doc files | expand

Message

Mariusz Tkaczyk March 26, 2024, 12:21 p.m. UTC 
This is an attempt to document some flows for submitters and
maintainers. It removes ANNOUNCE files in flavour of one
CHANGELOG.md, all releases are ported to this file.

For sure there are missing sections in README.md, for example I didn't
provide compilation HOWTO. If there are no objections I will do that
later.

I pushed it to my github to help with review:
https://github.com/mtkaczyk/mdadm/tree/add_md_files

You can either report suggestions here or on github. I will be happy
to answer.

Cc: Jes Sorensen <jes@trained-monkey.org>
Cc: Nix <nix@esperi.org.uk>

Mariusz Tkaczyk (3):
  mdadm: add CHANGELOG.md
  mdadm: Add MAINTAINERS.md
  mdadm: Add README.md

 ANNOUNCE-3.0   |  98 -------------
 ANNOUNCE-3.0.1 |  22 ---
 ANNOUNCE-3.0.2 |  21 ---
 ANNOUNCE-3.0.3 |  29 ----
 ANNOUNCE-3.1   |  33 -----
 ANNOUNCE-3.1.1 |  39 ------
 ANNOUNCE-3.1.2 |  46 -------
 ANNOUNCE-3.1.3 |  46 -------
 ANNOUNCE-3.1.4 |  37 -----
 ANNOUNCE-3.1.5 |  42 ------
 ANNOUNCE-3.2   |  77 -----------
 ANNOUNCE-3.2.1 |  75 ----------
 ANNOUNCE-3.2.2 |  36 -----
 ANNOUNCE-3.2.3 |  24 ----
 ANNOUNCE-3.2.4 | 144 -------------------
 ANNOUNCE-3.2.5 |  31 -----
 ANNOUNCE-3.2.6 |  57 --------
 ANNOUNCE-3.3   |  63 ---------
 ANNOUNCE-3.3.1 |  23 ----
 ANNOUNCE-3.3.2 |  16 ---
 ANNOUNCE-3.3.3 |  18 ---
 ANNOUNCE-3.3.4 |  37 -----
 ANNOUNCE-3.4   |  24 ----
 ANNOUNCE-4.0   |  22 ---
 ANNOUNCE-4.1   |  16 ---
 ANNOUNCE-4.2   |  19 ---
 CHANGELOG.md   | 368 +++++++++++++++++++++++++++++++++++++++++++++++++
 ChangeLog      | 306 ----------------------------------------
 MAINTAINERS.md |  44 ++++++
 README.md      |  83 +++++++++++
 30 files changed, 495 insertions(+), 1401 deletions(-)
 delete mode 100644 ANNOUNCE-3.0
 delete mode 100644 ANNOUNCE-3.0.1
 delete mode 100644 ANNOUNCE-3.0.2
 delete mode 100644 ANNOUNCE-3.0.3
 delete mode 100644 ANNOUNCE-3.1
 delete mode 100644 ANNOUNCE-3.1.1
 delete mode 100644 ANNOUNCE-3.1.2
 delete mode 100644 ANNOUNCE-3.1.3
 delete mode 100644 ANNOUNCE-3.1.4
 delete mode 100644 ANNOUNCE-3.1.5
 delete mode 100644 ANNOUNCE-3.2
 delete mode 100644 ANNOUNCE-3.2.1
 delete mode 100644 ANNOUNCE-3.2.2
 delete mode 100644 ANNOUNCE-3.2.3
 delete mode 100644 ANNOUNCE-3.2.4
 delete mode 100644 ANNOUNCE-3.2.5
 delete mode 100644 ANNOUNCE-3.2.6
 delete mode 100644 ANNOUNCE-3.3
 delete mode 100644 ANNOUNCE-3.3.1
 delete mode 100644 ANNOUNCE-3.3.2
 delete mode 100644 ANNOUNCE-3.3.3
 delete mode 100644 ANNOUNCE-3.3.4
 delete mode 100644 ANNOUNCE-3.4
 delete mode 100644 ANNOUNCE-4.0
 delete mode 100644 ANNOUNCE-4.1
 delete mode 100644 ANNOUNCE-4.2
 create mode 100644 CHANGELOG.md
 delete mode 100644 ChangeLog
 create mode 100644 MAINTAINERS.md
 create mode 100644 README.md

Comments

Mariusz Tkaczyk April 8, 2024, 9:23 a.m. UTC | #1 
On Tue, 26 Mar 2024 13:21:09 +0100
Mariusz Tkaczyk <mariusz.tkaczyk@linux.intel.com> wrote:

> This is an attempt to document some flows for submitters and
> maintainers. It removes ANNOUNCE files in flavour of one
> CHANGELOG.md, all releases are ported to this file.
> 
> For sure there are missing sections in README.md, for example I didn't
> provide compilation HOWTO. If there are no objections I will do that
> later.
> 
> I pushed it to my github to help with review:
> https://github.com/mtkaczyk/mdadm/tree/add_md_files
> 
> You can either report suggestions here or on github. I will be happy
> to answer.
> 
> Cc: Jes Sorensen <jes@trained-monkey.org>
> Cc: Nix <nix@esperi.org.uk>
> 

No feedback,

Applied!

Thanks,
Mariusz