URL: https://github.com/freeipa/freeipa/pull/520
Author: pvoborni
 Title: #520: Change README to use Markdown
Action: synchronized

To pull the PR as Git branch:
git remote add ghfreeipa https://github.com/freeipa/freeipa
git fetch ghfreeipa pull/520/head:pr520
git checkout pr520
From cad3bc057967b8d14529960d955c05183b00a279 Mon Sep 17 00:00:00 2001
From: Petr Vobornik <pvobo...@redhat.com>
Date: Tue, 28 Feb 2017 19:04:03 +0100
Subject: [PATCH] Change README to use Markdown

So that it will be nicely formatted on FreeIPA Pagure landing page.
  https://pagure.io/freeipa

Some links were updated as other projects also moved to Pagure.io.
---
 Makefile.am     |  1 +
 README          | 92 ---------------------------------------------------------
 README.md       | 73 +++++++++++++++++++++++++++++++++++++++++++++
 freeipa.spec.in | 32 ++++++++++----------
 4 files changed, 90 insertions(+), 108 deletions(-)
 delete mode 100644 README
 create mode 100644 README.md

diff --git a/Makefile.am b/Makefile.am
index a35d18f..c00ac2e 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -40,6 +40,7 @@ EXTRA_DIST = .mailmap \
 	     API.txt \
 	     BUILD.txt \
 	     config.rpath \
+	     README.md \
 	     Contributors.txt \
 	     COPYING.openssl \
 	     contrib \
diff --git a/README b/README
deleted file mode 100644
index ad5b081..0000000
--- a/README
+++ /dev/null
@@ -1,92 +0,0 @@
-
-                               IPA Server
-
-  Overview
-  --------
-
-  FreeIPA allows Linux administrators to centrally manage identity,
-  authentication and access control aspects of Linux and UNIX systems
-  by providing simple to install and use command line and web based
-  managment tools.
-  FreeIPA is built on top of well known Open Source components and standard
-  protocols with a very strong focus on ease of management and automation
-  of installation and configuration tasks.
-  FreeIPA can seamlessly integrate into an Active Directory environment via
-  cross-realm Kerberos trust or user synchronization.
-
-  Benefits
-  --------
-
-  FreeIPA:
-  * Allows all your users to access all the machines with the same credentials
-    and security settings
-  * Allows users to access personal files transparently from any machine in
-    an authenticated and secure way
-  * Uses an advanced grouping mechanism to restrict network access to services
-    and files only to specific users
-  * Allows central management of security mechanisms like passwords,
-    SSH Public Keys, SUDO rules, Keytabs, Access Control Rules
-  * Enables delegation of selected administrative tasks to other power users
-  * Integrates into Active Directory environments
-
-  Components
-  ----------
-
-  The FreeIPA project provides unified installation and management
-  tools for the following components:
-
-  * LDAP Server - based on the 389 project (LDAP)
-    http://directory.fedoraproject.org/wiki/Main_Page
-
-  * KDC - based on MIT Kerberos implementation
-    http://k5wiki.kerberos.org/wiki/Main_Page
-
-  * PKI based on Dogtag project
-    http://pki.fedoraproject.org/wiki/PKI_Main_Page
-
-  * Samba libraries for Active Directory integration
-    http://www.samba.org/
-
-  * DNS Server based on BIND and the Bind-DynDB-LDAP plugin
-    https://www.isc.org/software/bind
-    https://fedorahosted.org/bind-dyndb-ldap
-
-
-  Project Website
-  ---------------
-
-  Releases, announcements and other information can be found on the IPA
-  server project page at <http://www.freeipa.org/>.
-
-  Documentation
-  -------------
-
-  The most up-to-date documentation can be found at
-  <http://freeipa.org/page/Documentation>.
-
-  Quick Start
-  -----------
-
-  To get started quickly, start here:
-  <http://www.freeipa.org/page/Quick_Start_Guide>
-
-  Licensing
-  ---------
-
-  Please see the file called COPYING.
-
-  Contacts
-  --------
-
-     * If you want to be informed about new code releases, bug fixes,
-       security fixes, general news and information about the IPA server
-       subscribe to the freeipa-announce mailing list at
-       <https://www.redhat.com/mailman/listinfo/freeipa-interest/>.
-
-     * If you have a bug report please submit it at:
-       <https://bugzilla.redhat.com>
-
-     * If you want to participate in actively developing IPA please
-       subscribe to the freeipa-devel mailing list at
-       <https://www.redhat.com/mailman/listinfo/freeipa-devel/> or join
-       us in IRC at irc://irc.freenode.net/freeipa
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9608453
--- /dev/null
+++ b/README.md
@@ -0,0 +1,73 @@
+# FreeIPA Server
+
+FreeIPA allows Linux administrators to centrally manage identity,
+authentication and access control aspects of Linux and UNIX systems
+by providing simple to install and use command line and web based
+managment tools.
+
+FreeIPA is built on top of well known Open Source components and standard
+protocols with a very strong focus on ease of management and automation
+of installation and configuration tasks.
+
+FreeIPA can seamlessly integrate into an Active Directory environment via
+cross-realm Kerberos trust or user synchronization.
+
+## Benefits
+
+FreeIPA:
+
+* Allows all your users to access all the machines with the same credentials
+  and security settings
+* Allows users to access personal files transparently from any machine in
+  an authenticated and secure way
+* Uses an advanced grouping mechanism to restrict network access to services
+  and files only to specific users
+* Allows central management of security mechanisms like passwords,
+  SSH Public Keys, SUDO rules, Keytabs, Access Control Rules
+* Enables delegation of selected administrative tasks to other power users
+* Integrates into Active Directory environments
+
+## Components
+
+The FreeIPA project provides unified installation and management
+tools for the following components:
+
+* LDAP Server - based on the [389 project](http://www.port389.org/)
+* KDC - based on [MIT Kerberos](http://k5wiki.kerberos.org/wiki/Main_Page)
+  implementation
+* PKI based on [Dogtag project](http://pki.fedoraproject.org/wiki/PKI_Main_Page)
+* [Samba](http://www.samba.org/) libraries for Active Directory integration
+* DNS Server based on [BIND](https://www.isc.org/software/bind) and the
+  [Bind-DynDB-LDAP plugin](https://pagure.io/bind-dyndb-ldap)
+
+## Project Website
+
+Releases, announcements and other information can be found on the IPA
+server project page at http://www.freeipa.org/ .
+
+## Documentation
+
+The most up-to-date documentation can be found at
+http://freeipa.org/page/Documentation .
+
+## Quick Start
+
+To get started quickly, start here:
+http://www.freeipa.org/page/Quick_Start_Guide
+
+## Licensing
+
+Please see the file called COPYING.
+
+## Contacts
+
+* If you want to be informed about new code releases, bug fixes,
+  security fixes, general news and information about the IPA server
+  subscribe to the freeipa-announce mailing list at
+  https://www.redhat.com/mailman/listinfo/freeipa-interest/ .
+* If you have a bug report please submit it at:
+  https://pagure.io/freeipa/issues
+* If you want to participate in actively developing IPA please
+  subscribe to the freeipa-devel mailing list at
+  https://www.redhat.com/mailman/listinfo/freeipa-devel/ or join
+  us in IRC at <irc://irc.freenode.net/freeipa>
diff --git a/freeipa.spec.in b/freeipa.spec.in
index 5c835ca..a16f526 100644
--- a/freeipa.spec.in
+++ b/freeipa.spec.in
@@ -1084,7 +1084,7 @@ fi
 
 %files server
 %defattr(-,root,root,-)
-%doc README Contributors.txt
+%doc README.md Contributors.txt
 %license COPYING
 %{_sbindir}/ipa-backup
 %{_sbindir}/ipa-restore
@@ -1172,7 +1172,7 @@ fi
 
 %files -n python2-ipaserver
 %defattr(-,root,root,-)
-%doc README Contributors.txt
+%doc README.md Contributors.txt
 %license COPYING
 %{python2_sitelib}/ipaserver
 %{python2_sitelib}/ipaserver-*.egg-info
@@ -1182,7 +1182,7 @@ fi
 
 %files -n python3-ipaserver
 %defattr(-,root,root,-)
-%doc README Contributors.txt
+%doc README.md Contributors.txt
 %license COPYING
 %{python3_sitelib}/ipaserver
 %{python3_sitelib}/ipaserver-*.egg-info
@@ -1192,7 +1192,7 @@ fi
 
 %files server-common
 %defattr(-,root,root,-)
-%doc README Contributors.txt
+%doc README.md Contributors.txt
 %license COPYING
 %ghost %verify(not owner group) %dir %{_sharedstatedir}/kdcproxy
 %dir %attr(0755,root,root) %{_sysconfdir}/ipa/kdcproxy
@@ -1294,7 +1294,7 @@ fi
 
 %files server-dns
 %defattr(-,root,root,-)
-%doc README Contributors.txt
+%doc README.md Contributors.txt
 %license COPYING
 %{_sbindir}/ipa-dns-install
 %{_mandir}/man1/ipa-dns-install.1*
@@ -1302,7 +1302,7 @@ fi
 
 %files server-trust-ad
 %defattr(-,root,root,-)
-%doc README Contributors.txt
+%doc README.md Contributors.txt
 %license COPYING
 %{_sbindir}/ipa-adtrust-install
 %{_usr}/share/ipa/smb.conf.empty
@@ -1318,7 +1318,7 @@ fi
 
 %files client
 %defattr(-,root,root,-)
-%doc README Contributors.txt
+%doc README.md Contributors.txt
 %license COPYING
 %{_sbindir}/ipa-client-install
 %{_sbindir}/ipa-client-automount
@@ -1339,7 +1339,7 @@ fi
 
 %files -n python2-ipaclient
 %defattr(-,root,root,-)
-%doc README Contributors.txt
+%doc README.md Contributors.txt
 %license COPYING
 %dir %{python_sitelib}/ipaclient
 %{python_sitelib}/ipaclient/*.py*
@@ -1354,7 +1354,7 @@ fi
 
 %files -n python3-ipaclient
 %defattr(-,root,root,-)
-%doc README Contributors.txt
+%doc README.md Contributors.txt
 %license COPYING
 %dir %{python3_sitelib}/ipaclient
 %{python3_sitelib}/ipaclient/*.py
@@ -1374,7 +1374,7 @@ fi
 
 %files client-common
 %defattr(-,root,root,-)
-%doc README Contributors.txt
+%doc README.md Contributors.txt
 %license COPYING
 %dir %attr(0755,root,root) %{_sysconfdir}/ipa/
 %ghost %attr(0644,root,apache) %config(noreplace) %{_sysconfdir}/ipa/default.conf
@@ -1393,13 +1393,13 @@ fi
 
 %files python-compat
 %defattr(-,root,root,-)
-%doc README Contributors.txt
+%doc README.md Contributors.txt
 %license COPYING
 
 
 %files -n python2-ipalib
 %defattr(-,root,root,-)
-%doc README Contributors.txt
+%doc README.md Contributors.txt
 %license COPYING
 %dir %{python_sitelib}/ipapython
 %{python_sitelib}/ipapython/*.py*
@@ -1418,7 +1418,7 @@ fi
 
 %files common -f %{gettext_domain}.lang
 %defattr(-,root,root,-)
-%doc README Contributors.txt
+%doc README.md Contributors.txt
 %license COPYING
 
 
@@ -1426,7 +1426,7 @@ fi
 
 %files -n python3-ipalib
 %defattr(-,root,root,-)
-%doc README Contributors.txt
+%doc README.md Contributors.txt
 %license COPYING
 
 %{python3_sitelib}/ipapython/
@@ -1443,7 +1443,7 @@ fi
 
 %files -n python2-ipatests
 %defattr(-,root,root,-)
-%doc README Contributors.txt
+%doc README.md Contributors.txt
 %license COPYING
 %{python_sitelib}/ipatests
 %{python_sitelib}/ipatests-*.egg-info
@@ -1464,7 +1464,7 @@ fi
 
 %files -n python3-ipatests
 %defattr(-,root,root,-)
-%doc README Contributors.txt
+%doc README.md Contributors.txt
 %license COPYING
 %{python3_sitelib}/ipatests
 %{python3_sitelib}/ipatests-*.egg-info
-- 
Manage your subscription for the Freeipa-devel mailing list:
https://www.redhat.com/mailman/listinfo/freeipa-devel
Contribute to FreeIPA: http://www.freeipa.org/page/Contribute/Code

Reply via email to