From 2f5350a4dc0a7ec201e0d11d70a10d0a1ecf8ec8 Mon Sep 17 00:00:00 2001 From: Russ Allbery Date: Sun, 3 Jun 2018 13:43:24 -0700 Subject: Rewrite documentation using DocKnot Numerous fixes to the README file by converging on standard templates. Add a README.md for GitHub. Break thanks out into a separate THANKS file following the convention used by remctl. --- docs/metadata/metadata.json | 246 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 246 insertions(+) create mode 100644 docs/metadata/metadata.json (limited to 'docs/metadata/metadata.json') diff --git a/docs/metadata/metadata.json b/docs/metadata/metadata.json new file mode 100644 index 0000000..5e1ad41 --- /dev/null +++ b/docs/metadata/metadata.json @@ -0,0 +1,246 @@ +{ + "name": "wallet", + "version": "1.4", + "synopsis": "secure data management system", + "maintainer": "Russ Allbery ", + "copyrights": [ + { + "holder": "Russ Allbery ", + "years": "2014, 2016, 2018", + }, + { + "holder": "The Board of Trustees of the Leland Stanford Junior University", + "years": "2006-2010, 2012-2014", + }, + ], + "license": "Expat", + "build": { + "autotools": true, + "automake": "1.11", + "autoconf": "2.64", + "install": true, + "kerberos": true, + "lancaster": true, + "manpages": true, + "reduced_depends": true, + "type": "Autoconf", + }, + "support": { + "email": "eagle@eyrie.org", + "github": "rra/wallet", + "listname": "kerberos@mit.edu", + "listurl": "https://mailman.mit.edu/mailman/listinfo/kerberos", + "web": "https://www.eyrie.org/~eagle/software/wallet/", + }, + "vcs": { + "type": "Git", + "url": "https://git.eyrie.org/git/kerberos/wallet.git", + "browse": "https://git.eyrie.org/?p=kerberos/wallet.git", + "github": "rra/wallet", + "openhub": "https://www.openhub.net/p/wallet", + "travis": "rra/wallet", + }, + "readme": { + "sections": [ + { "title": "Configuration" }, + ], + }, + "quote": { + "author": "John M. Ford", + "work": "Growing Up Weightless", + }, + "distribution": { + "section": "kerberos", + "tarname": "wallet", + "version": "wallet", + }, + "debian": { + "personal": true, + }, + "docs": { + "user": [ + { + "name": "setup", + "title": "Setup and configuration", + }, + { + "name": "config", + "title": "Configuration options", + }, + { + "name": "objects-and-schemes", + "title": "Objects and ACL schemes", + }, + { + "name": "wallet", + "title": "wallet", + }, + { + "name": "wallet-admin", + "title": "wallet-admin", + }, + { + "name": "wallet-backend", + "title": "wallet-backend", + }, + { + "name": "wallet-report", + "title": "wallet-report", + }, + { + "name": "keytab-backend", + "title": "keytab-backend", + }, + { + "name": "naming", + "title": "Stanford wallet naming policy", + }, + { + "name": "thanks", + "title": "Thanks and credits", + }, + ], + "developer": [ + { + "name": "design", + "title": "Overall design", + }, + { + "name": "design-acl", + "title": "ACL design", + }, + { + "name": "design-api", + "title": "Server module API design", + }, + ], + "contrib": [ + { + "name": "used-principals", + "title": "used-principals", + }, + { + "name": "wallet-contacts", + "title": "wallet-contacts", + }, + { + "name": "wallet-rekey-periodic", + "title": "wallet-rekey-periodic", + }, + { + "name": "wallet-summary", + "title": "wallet-summary", + }, + { + "name": "wallet-unknown-hosts", + "title": "wallet-unknown-hosts", + } + ], + "api": [ + { + "name": "api/acl", + "title": "Wallet::ACL", + }, + { + "name": "api/acl-base", + "title": "Wallet::ACL::Base", + }, + { + "name": "api/acl-external", + "title": "Wallet::ACL::External", + }, + { + "name": "api/acl-krb5", + "title": "Wallet::ACL::Krb5", + }, + { + "name": "api/acl-krb5-regex", + "title": "Wallet::ACL::Krb5::Regex", + }, + { + "name": "api/acl-ldap-attr", + "title": "Wallet::ACL::LDAP::Attribute", + }, + { + "name": "api/acl-ldap-attr-root", + "title": "Wallet::ACL::LDAP::Attribute::Root", + }, + { + "name": "api/acl-nested", + "title": "Wallet::ACL::Nested", + }, + { + "name": "api/acl-netdb", + "title": "Wallet::ACL::NetDB", + }, + { + "name": "api/acl-netdb-root", + "title": "Wallet::ACL::NetDB::Root", + }, + { + "name": "api/admin", + "title": "Wallet::Admin", + }, + { + "name": "api/config", + "title": "Wallet::Config", + }, + { + "name": "api/database", + "title": "Wallet::Database", + }, + { + "name": "api/kadmin", + "title": "Wallet::Kadmin", + }, + { + "name": "api/kadmin-ad", + "title": "Wallet::Kadmin::AD", + }, + { + "name": "api/kadmin-heimdal", + "title": "Wallet::Kadmin::Heimdal", + }, + { + "name": "api/kadmin-mit", + "title": "Wallet::Kadmin::MIT", + }, + { + "name": "api/object-base", + "title": "Wallet::Object::Base", + }, + { + "name": "api/object-duo", + "title": "Wallet::Object::Duo", + }, + { + "name": "api/object-file", + "title": "Wallet::Object::File", + }, + { + "name": "api/object-keytab", + "title": "Wallet::Object::Keytab", + }, + { + "name": "api/object-password", + "title": "Wallet::Object::Password", + }, + { + "name": "api/policy-stanford", + "title": "Wallet::Policy::Stanford", + }, + { + "name": "api/report", + "title": "Wallet::Report", + }, + { + "name": "api/schema", + "title": "Wallet::Schema", + }, + { + "name": "api/server", + "title": "Wallet::Server", + }, + ], + }, +} -- cgit v1.2.3 From 85f851653191bb9f0fc8435ada239f00f182d34a Mon Sep 17 00:00:00 2001 From: Russ Allbery Date: Sun, 3 Jun 2018 13:48:20 -0700 Subject: Adjust wording for the kerberos mailing list May as well not publicize the full email address for spammers to scrape. --- README | 4 ++-- README.md | 6 +++--- docs/metadata/metadata.json | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) (limited to 'docs/metadata/metadata.json') diff --git a/README b/README index 0a7fdae..c9a418f 100644 --- a/README +++ b/README @@ -294,8 +294,8 @@ SUPPORT will always have the current version of this package, the current documentation, and pointers to any additional resources. - New wallet releases are announced on the kerberos@mit.edu mailing list. - To subscribe or see the list archives, go to: + New wallet releases are announced on the kerberos mailing list. To + subscribe or see the list archives, go to: https://mailman.mit.edu/mailman/listinfo/kerberos diff --git a/README.md b/README.md index f9708f3..b1afe4e 100644 --- a/README.md +++ b/README.md @@ -305,9 +305,9 @@ The [wallet web page](https://www.eyrie.org/~eagle/software/wallet/) will always have the current version of this package, the current documentation, and pointers to any additional resources. -New wallet releases are announced on the kerberos@mit.edu mailing list. -To subscribe or see the list archives, go to the [kerberos@mit.edu -management page](https://mailman.mit.edu/mailman/listinfo/kerberos). +New wallet releases are announced on the kerberos mailing list. To +subscribe or see the list archives, go to the [kerberos list information +page](https://mailman.mit.edu/mailman/listinfo/kerberos). For bug tracking, use the [issue tracker on GitHub](https://github.com/rra/wallet/issues). However, please be aware diff --git a/docs/metadata/metadata.json b/docs/metadata/metadata.json index 5e1ad41..5426422 100644 --- a/docs/metadata/metadata.json +++ b/docs/metadata/metadata.json @@ -28,7 +28,7 @@ "support": { "email": "eagle@eyrie.org", "github": "rra/wallet", - "listname": "kerberos@mit.edu", + "listname": "kerberos", "listurl": "https://mailman.mit.edu/mailman/listinfo/kerberos", "web": "https://www.eyrie.org/~eagle/software/wallet/", }, -- cgit v1.2.3