marcuskammer/emacs.d
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
emacs.d/clones/lisp/clojure-doc.org/articles/about/index.html

217 lines
16 KiB
HTML
Raw Normal View History

Update clones
2022-08-24 19:36:32 +02:00
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<meta charset="utf-8"/>
<title>Clojure Guides: About</title>
<meta name="description" content="CDS (Clojure Documentation Site) is a community documentation project for the Clojure programming language. It is not affiliated with
Clojure/core, does not require going through the Clojure Contributor Agreement, and is developed on GitHub.Rationale">
<meta property="og:description" content="CDS (Clojure Documentation Site) is a community documentation project for the Clojure programming language. It is not affiliated with
Clojure/core, does not require going through the Clojure Contributor Agreement, and is developed on GitHub.Rationale">
<meta property="og:url" content="https://clojure-doc.github.io/articles/about/" />
<meta property="og:title" content="About" />
<meta property="og:type" content="article" />
<link rel="canonical" href="https://clojure-doc.github.io/articles/about/">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link href="https://fonts.googleapis.com/css?family=Alegreya:400italic,700italic,400,700" rel="stylesheet"
type="text/css">
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.0/css/bootstrap.min.css">
<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.2.0/css/font-awesome.min.css" rel="stylesheet">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.7.0/styles/default.min.css">
<link href="../../css/screen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<nav class="navbar navbar-default">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../../index.html">Clojure Guides</a>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav navbar-right">
<li ><a href="../../index.html">Home</a></li>
<li><a href="https://github.com/clojure-doc/clojure-doc.github.io">Contribute</a></li>
</ul>
</div><!--/.nav-collapse -->
</div><!--/.container-fluid -->
</nav>
<div class="container">
<div class="row">
<div class="col-lg-9">
<div id="content">
<div id="custom-page">
<div id="page-header">
<h2>About</h2>
</div>
<p>CDS (Clojure Documentation Site) is a community documentation project for the Clojure programming language. It is not affiliated with
<code>Clojure/core</code>, does not require going through the Clojure Contributor Agreement, and is developed <a href="https://github.com/clojure-doc/clojure-doc.github.io">on GitHub</a>.</p><h2 id="rationale">Rationale</h2><p>The rationale is explained in more detail in the <a href="http://blog.clojurewerkz.org/blog/2012/10/10/announcing-a-new-clojure-documentation-project/">announcement blog post</a>.</p><h2 id="history">History</h2><p>CDS was started in early October, 2012, by several active members of the Clojure community due to their dissatisfaction
with the state of documentation and documentation contribution process (that involved mailing Clojure Contributor Agreement in paper).</p><h2 id="goals">Goals</h2><p>The goal is to produce quality technical documentation for Clojure users and potential adopters with various expertise levels.</p><p>CDS strives to cover all aspects of Clojure: from tutorials and language guides to overview of the ecosystem, how
libraries are developed and published, topics operations engineers will be interested in, JVM ecosystem tools
and so on.</p><p>Adopting a language always takes more than just reading a book or a few tutorials about language features. Understanding
design goals, the ecosystem and operations is just as important. CDS will try to address this.</p><h3 id="what-cds-is-not">What CDS is Not</h3><p>What's <em>not</em> here:</p><ul><li>Cheatsheets. The official <a href="http://clojure.org/cheatsheet">Clojure cheatsheet</a> is very good. There is also an unofficial <a href="https://github.com/fogus/clojurescript-cheatsheet">ClojureScript cheatsheet</a> available for download and contribution.</li><li>API reference docs. Those can currently be found (with examples) at <a href="http://clojuredocs.org/">Clojuredocs</a>.</li></ul><p>Clojuredocs needs a lot of work and redesign (as in, the way it works) which will take a while. CDS is not concerned with providing the API reference;
only tutorials, guides, and linking to other relevant resources.</p><h2 id="structure">Structure</h2><p>CDS is structured as a number of guides. They broadly fall into 4 categories:</p><ul><li><a href="https://clojure-doc.org/articles/about/content/#clojure_tutorials">Tutorials</a></li><li><a href="https://clojure-doc.org/articles/about/content/#clojure_language_guides">Language Guides</a></li><li><a href="https://clojure-doc.org/articles/about/content/#the_clojure_ecosystem">Ecosystem &amp; Tools</a></li><li><a href="https://clojure-doc.org/articles/about/content/#cookbooks">Cookbooks</a></li></ul><h3 id="tutorials">Tutorials</h3><p>These guides are for complete newcomers and should include a lot of hand holding. They don't assume any
previous familiarity with Clojure, the JVM, the JVM tool ecosystem, functional programming, immutability, and so on.</p><p>Target audience: newcomers to the language.</p><h3 id="language-guides">Language guides</h3><p>These guides are more in-depth, focused on various aspects of the language and interoperability.
Examples of such guides include:</p><ul><li>Sequences</li><li>Interoperability</li><li>Reference types</li><li>Laziness</li><li>Macros and compilation</li></ul><p>Target audience: from developers who already have some familiarity with the language to those who have been using it for
a while.</p><h3 id="tools--ecosystem-guides">Tools &amp; Ecosystem guides</h3><p>These guides cover key Clojure ecosystem tools such as <a href="http://leiningen.org">Leiningen</a>, <a href="http://clojars.org">Clojars</a>, <a href="https://github.com/trptcolin/reply">REPLy</a>,
<a href="https://github.com/clojure/tools.nrepl">nREPL</a>, <a href="https://github.com/technomancy/clojure-mode">Emacs clojure-mode</a>, VimClojure, <a href="https://code.google.com/p/counterclockwise/">Counterclockwise</a>, <a href="http://plugins.jetbrains.com/plugin?pluginId=4050">La Clojure</a>, etc. It also covers important ecosystem projects that are not tools: books,
<a href="http://www.clojuresphere.com/">ClojureSphere</a>, <a href="http://clojurewerkz.org/">ClojureWerkz</a>, <a href="https://github.com/flatland">Flatland</a> and so on.</p><p>Target audience: all developers using or interested in the Clojure programming language.</p><h3 id="cookbooks">Cookbooks</h3><p>Concise <a href="https://clojure-doc.org/articles/about/content/#cookbooks">Clojure example code</a>, categorized by subject.</p><h2 id="mailing-list">Mailing List</h2><p>CDS <a href="https://groups.google.com/group/clojure">currently uses Clojure mailing list</a> for discussions. Feel free to join it and ask any questions you may have.</p><h2 id="news--announcements">News &amp; Announcements</h2><p>News and announcements are posted primarily on the <a href="https://clojurians.slack.com/archives/C8NUSGWG6">Clojurians Slack <code>#news-and-articles</code> channel</a>.</p><h2 id="reporting-issues">Reporting Issues</h2><p>If you find a mistake, poor grammar, an important topic not covered, or an outdated example, please <a href="https://github.com/clojure-doc/clojure-doc.github.io/issues">file an issue</a> on Github.</p><h2 id="contributing">Contributing</h2><p>CDS uses <a href="http://cryogenweb.org/">Cryogen</a>. All tutorials and guides are written in Markdown.</p><p>The toolchain and setup process are described <a href="https://github.com/clojure-doc/clojure-doc.github.io/blob/main/README.md#toolchain">in the README</a>.</p><p>To submit changes, create a branch and make your changes on it. Once you are done with your changes and all tests pass, submit a pull request
on GitHub.</p>
<div id="prev-next">
<a href="../content/index.html">Table of Contents &raquo;</a>
</div>
</div>
</div>
</div>
<div class="col-md-3">
<div id="sidebar">
<h3>Links</h3>
<ul id="links">
<li><a href="index.html">About</a></li>
<li><a href="../content/index.html">Table of Contents</a></li>
<li><a href="../tutorials/getting_started/index.html">Getting Started with Clojure</a></li>
<li><a href="../tutorials/introduction/index.html">Introduction to Clojure</a></li>
<li><a href="../tutorials/emacs/index.html">Clojure with Emacs</a></li>
<li><a href="../tutorials/vim_fireplace/index.html">Clojure with Vim and fireplace.vim</a></li>
<li><a href="../tutorials/eclipse/index.html">Starting with Eclipse and Counterclockwise For Clojure Development</a></li>
<li><a href="../tutorials/basic_web_development/index.html">Basic Web Development</a></li>
<li><a href="../tutorials/parsing_xml_with_zippers/index.html">Parsing XML in Clojure</a></li>
<li><a href="../tutorials/growing_a_dsl_with_clojure/index.html">Growing a DSL with Clojure</a></li>
<li><a href="../language/core_overview/index.html">Overview of clojure.core, the standard Clojure library</a></li>
<li><a href="../language/namespaces/index.html">Clojure Namespaces and Vars</a></li>
<li><a href="../language/collections_and_sequences/index.html">Collections and Sequences in Clojure</a></li>
<li><a href="../language/functions/index.html">Functions in Clojure</a></li>
<li><a href="../language/laziness/index.html">Laziness in Clojure</a></li>
<li><a href="../language/interop/index.html">Clojure interoperability with Java</a></li>
<li><a href="../language/macros/index.html">Clojure Macros and Metaprogramming</a></li>
<li><a href="../language/polymorphism/index.html">Polymorphism in Clojure: Protocols and Multimethods</a></li>
<li><a href="../language/concurrency_and_parallelism/index.html">Concurrency and Parallelism in Clojure</a></li>
<li><a href="../language/glossary/index.html">Clojure Terminology Guide</a></li>
<li><a href="../ecosystem/libraries_directory/index.html">A Directory of Clojure Libraries</a></li>
<li><a href="../ecosystem/libraries_authoring/index.html">Library Development and Distribution</a></li>
<li><a href="../ecosystem/generating_documentation/index.html">Generating Documentation</a></li>
<li><a href="../ecosystem/data_processing/index.html">Data Processing (Help Wanted)</a></li>
<li><a href="../ecosystem/web_development/index.html">Web Development (Overview)</a></li>
<li><a href="../ecosystem/maven/index.html">How to use Maven to build Clojure projects</a></li>
<li><a href="../ecosystem/community/index.html">Clojure Community</a></li>
<li><a href="../ecosystem/user_groups/index.html">Clojure User Groups</a></li>
<li><a href="../ecosystem/running_cljug/index.html">Running a Clojure User Group</a></li>
<li><a href="../ecosystem/books/index.html">Books about Clojure and ClojureScript</a></li>
<li><a href="../cookbooks/data_structures/index.html">Data Structures (Help wanted)</a></li>
<li><a href="../cookbooks/strings/index.html">Strings</a></li>
<li><a href="../cookbooks/math/index.html">Mathematics with Clojure</a></li>
<li><a href="../cookbooks/date_and_time/index.html">Date and Time (Help wanted)</a></li>
<li><a href="../cookbooks/files_and_directories/index.html">Working with Files and Directories in Clojure</a></li>
<li><a href="../cookbooks/middleware/index.html">Middleware in Clojure</a></li>
<li><a href="../ecosystem/java_jdbc/home.html">java.jdbc - Getting Started</a></li>
<li><a href="../ecosystem/java_jdbc/using_sql.html">java.jdbc - Manipulating data with SQL</a></li>
<li><a href="../ecosystem/java_jdbc/using_ddl.html">java.jdbc - Using DDL and Metadata</a></li>
<li><a href="../ecosystem/java_jdbc/reusing_connections.html">java.jdbc - How to reuse database connections</a></li>
<li><a href="../ecosystem/core_typed/home/index.html">core.typed - User Documentation Home</a></li>
<li><a href="../ecosystem/core_typed/user_documentation/index.html">core.typed - User Documentation</a></li>
<li><a href="../ecosystem/core_typed/rationale/index.html">core.typed - Rationale</a></li>
<li><a href="../ecosystem/core_typed/quick_guide.html">core.typed - Quick Guide</a></li>
<li><a href="../ecosystem/core_typed/start/introduction_and_motivation/index.html">core.typed - Getting Started: Introduction and Motivation</a></li>
<li><a href="../ecosystem/core_typed/types/index.html">core.typed - Types</a></li>
<li><a href="../ecosystem/core_typed/start/annotations/index.html">core.typed - Annotations</a></li>
<li><a href="../ecosystem/core_typed/poly_fn/index.html">core.typed - Polymorphic Functions</a></li>
<li><a href="../ecosystem/core_typed/filters/index.html">core.typed - Filters</a></li>
<li><a href="../ecosystem/core_typed/mm_protocol_datatypes/index.html">core.typed - Protocols</a></li>
<li><a href="../ecosystem/core_typed/loops/index.html">core.typed - Looping constructs</a></li>
<li><a href="../ecosystem/core_typed/function_types/index.html">core.typed - Functions</a></li>
<li><a href="../ecosystem/core_typed/limitations/index.html">core.typed - Limitations</a></li>
</ul>
</div>
</div>
</div>
<footer>Copyright &copy; 2021 Multiple Authors
<p style="text-align: center;">Powered by <a href="http://cryogenweb.org">Cryogen</a></p></footer>
</div>
<script src="https://code.jquery.com/jquery-1.11.0.min.js"></script>
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.0/js/bootstrap.min.js"></script>
<script src="../../js/highlight.pack.js" type="application/javascript"></script>
<script>hljs.initHighlightingOnLoad();</script>
</body>
</html>
Reference in a new issue Copy permalink