Skip to content

Commit 05ab951

Browse files
committed
address #23 by cleaning up readme/about
1 parent 7ea2a30 commit 05ab951

File tree

4 files changed

+48
-59
lines changed

4 files changed

+48
-59
lines changed

README.md

+26-36
Original file line numberDiff line numberDiff line change
@@ -2,33 +2,33 @@
22

33
An assorted collection of tutorials, guides, and other documentation
44
(by various authors) for the Clojure programming language and its
5-
ecosystem. [Read the guides online](https://clojure-doc.github.io).
5+
ecosystem. [Read the guides online](https://clojure-doc.org).
66

7-
> Note: due to loss of access to the original infrastructure hosting http://clojure-doc.org, this is a reboot of that site using [Cryogen](http://cryogenweb.org/) and hosted as a GitHub organization website. _Sean Corfield, November 14th, 2021._
7+
> Note: due to loss of access to the original infrastructure hosting http://clojure-doc.org, this is a reboot of that site using [Cryogen](https://cryogenweb.org/) and hosted as a GitHub organization website. _Sean Corfield, November 14th, 2021._
88
99
> **Pull Requests should be made against the `source` branch, with changes to the Markdown files. The HTML on the `main` branch is auto-generated using Cryogen.**
1010
11+
> *News: funding for extensive work on CDS in 2023 is generally provided by [Clojurists Together](https://www.clojuriststogether.org/news/clojurists-together-2023-long-term-funding-announcement/) as part of their Long-Term Funding for [Sean Corfield](https://github.com/seancorfield).*
12+
1113
## Goals
1214

1315
The goal is to produce quality technical documentation with limited
14-
duplication between guides, and eventually have these documents hosted
15-
at doc.clojure.org.
16-
16+
duplication between guides.
1717

1818
What's *not* here:
1919

2020
* Cheatsheets. Those can be found at
21-
[clojure.org/cheatsheet](https://clojure.org/api/cheatsheet), or with
22-
tooltips at
23-
[jafingerhut.github.com](http://jafingerhut.github.com). There is also an unofficial [ClojureScript cheatsheet](https://github.com/fogus/clojurescript-cheatsheet) available for download and contribution.
24-
* API reference docs. Those can currently be found (with examples)
25-
at [Clojuredocs](http://clojuredocs.org/).
21+
[clojure.org/cheatsheet](https://clojure.org/api/cheatsheet), which is derived from
22+
[jafingerhut.github.io](https://jafingerhut.github.io/),
23+
and [cljs.info/cheatsheet](https://cljs.info/cheatsheet/), which is derived from
24+
[oakmac/cljs-cheatsheet](https://github.com/oakmac/cljs-cheatsheet/).
25+
* API reference docs. The [official API docs](https://clojure.org/api/api)
26+
also have a community-maintained version with examples
27+
at [ClojureDocs](https://clojuredocs.org/).
2628

2729
CDS is not concerned with providing the API reference; only tutorials, guides, and
2830
linking to other relevant resources.
2931

30-
31-
3232
## Structure
3333

3434
CDS is structured as a number of guides. They broadly fall into 4 categories:
@@ -41,7 +41,7 @@ CDS is structured as a number of guides. They broadly fall into 4 categories:
4141

4242
### Tutorials
4343

44-
These guides are for complete newcomers and should include a lot of hand holding. They don't assume any
44+
These guides are intended for complete newcomers and should include a lot of hand holding. They don't assume any
4545
previous familiarity with Clojure, the JVM, the JVM tool ecosystem, functional programming, immutability, and so on.
4646

4747
Target audience: newcomers to the language.
@@ -52,21 +52,21 @@ Target audience: newcomers to the language.
5252
These guides are more in-depth, focused on various aspects of the language and interoperability.
5353
Examples of such guides include:
5454

55-
* Sequences
55+
* Collections & Sequences
56+
* Concurrency & Parallelism
5657
* Interoperability
57-
* Reference types
5858
* Laziness
59-
* Macros and compilation
59+
* Macros
6060

6161
Target audience: from developers who already have some familiarity with the language to those who have been using it for
6262
a while.
6363

6464

6565
### Tools & Ecosystem guides
6666

67-
These guides cover key Clojure ecosystem tools such as [Leiningen](http://leiningen.org), [Clojars](http://clojars.org), [REPLy](https://github.com/trptcolin/reply),
68-
nREPL, Emacs clojure-mode, VimClojure, Counterclockwise, La Clojure, etc. It also covers important ecosystem projects that are not tools: books,
69-
ClojureSphere, ClojureWerkz, Flatland and so on.
67+
These guides cover key Clojure ecosystem tools such as [Leiningen](https://leiningen.org), [Clojars](https://clojars.org),
68+
nREPL, Emacs, vim/neovim, Calva, etc. It also covers important ecosystem projects that are not tools: books,
69+
communities, etc.
7070

7171
Target audience: all developers using or interested in the language.
7272

@@ -77,19 +77,9 @@ Target audience: all developers using or interested in the language.
7777
Concise Clojure example code, categorized by subject.
7878

7979

80-
81-
8280
## How To Contribute
8381

84-
First of all: you **can** contribute to Clojure documentation even if you have 15 minutes to spare a day. To give you an example,
85-
here's what 2 people could produce in about 6 months in their spare time:
86-
87-
* [Monger documentation](http://clojuremongodb.info)
88-
* [Neocons documentation](http://clojureneo4j.info)
89-
* [Welle documentation](http://clojureriak.info)
90-
* [Elastisch documentation](http://clojureelasticsearch.info)
91-
* [Langohr documentation](http://clojurerabbitmq.info)
92-
* [Quartzite documentation](http://clojurequartz.info)
82+
First of all: you **can** contribute to Clojure documentation even if you have 15 minutes to spare a day.
9383

9484
No contribution is too small: feel free to suggest grammar improvements, better code examples, submit pull requests with just
9585
one new paragraph or even a couple of spelling corrections. Editing and proof-reading is also a great way to contribute.
@@ -105,11 +95,11 @@ Thank you!
10595

10696
### Toolchain
10797

108-
This site is built with [Cryogen](http://cryogenweb.org/) and hosted as a GitHub organization website.
98+
This site is built with [Cryogen](https://cryogenweb.org/) and hosted as a GitHub organization website.
10999

110100
Clone the repository, checkout the `source` branch, and run `clojure -M:build` to generate the `public` folder
111101
containing the rendered HTML version of the site (which is actually the `main` branch of the repository, so that
112-
it is published to https://clojure-doc.github.io automatically).
102+
it is published to https://clojure-doc.org automatically).
113103

114104
You can view the generated version with `clojure -X:serve` which should open a browser to port 3000 (of localhost).
115105
This will automatically regenerate the `public` folder as files are changed in `content` etc.
@@ -120,12 +110,12 @@ See [Klipse.md](Klipse.md) for instructions about including interactive code sni
120110

121111
First, pick a topic that sounds interesting. Writing documentation takes some effort and
122112
working on something that is interesting to you will motivate you. Next, find the article you want
123-
to contribute to under `./articles/`. It is a Markdown file with inline code snippets.
113+
to contribute to under `./content/md/articles/`. It is a Markdown file with inline code snippets.
124114

125115
At the top of each article you will usually find what it is supposed to cover. Please stick
126116
to that list.
127117

128-
Then fork the repository, create a [topic branch](http://git-scm.com/book/en/Git-Branching-Branching-Workflows), and
118+
Then fork the repository, create a [topic branch](https://git-scm.com/book/en/v2/Git-Branching-Branching-Workflows), and
129119
start writing.
130120

131121
When writing, periodically view results in the browser (see `clojure -X:serve` described above for running a local server) and make
@@ -142,7 +132,7 @@ All good documentation out there is a result of dozens of edits, corrections, an
142132
rewrites. This is normal. We want Clojure documentation to be high quality just like the language and
143133
`clojure.core`.
144134

145-
For some guidance on writing great documentation, see <http://jacobian.org/writing/great-documentation/>.
135+
For some guidance on writing great documentation, see <https://jacobian.org/series/great-documentation/>.
146136

147137

148138

@@ -181,5 +171,5 @@ review and discussions for new content, but you will be able to push small impro
181171
## License
182172

183173
All the content is distributed under the
184-
[CC BY 3.0](http://creativecommons.org/licenses/by/3.0/) license
174+
[CC BY 3.0](https://creativecommons.org/licenses/by/3.0/) license
185175
and are copyright their respective primary author(s).

content/config.edn

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{:site-title "Clojure Guides"
22
:author "Multiple Authors"
33
:description "Clojure Documentation"
4-
:site-url "https://clojure-doc.github.io/"
4+
:site-url "https://clojure-doc.org/"
55
:post-root "posts"
66
:page-root "articles"
77
:post-root-uri "posts"

content/md/articles/about.md

+20-14
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,14 @@ design goals, the ecosystem and operations is just as important. CDS will try to
3131

3232
What's *not* here:
3333

34-
* Cheatsheets. The official [Clojure cheatsheet](http://clojure.org/cheatsheet) is very good. There is also an unofficial [ClojureScript cheatsheet](https://github.com/fogus/clojurescript-cheatsheet) available for download and contribution.
35-
* API reference docs. Those can currently be found (with examples) at [Clojuredocs](http://clojuredocs.org/).
34+
* Cheatsheets. Those can be found at
35+
[clojure.org/cheatsheet](https://clojure.org/api/cheatsheet), which is derived from
36+
[jafingerhut.github.io](https://jafingerhut.github.io/),
37+
and [cljs.info/cheatsheet](https://cljs.info/cheatsheet/), which is derived from
38+
[oakmac/cljs-cheatsheet](https://github.com/oakmac/cljs-cheatsheet/).
39+
* API reference docs. The [official API docs](https://clojure.org/api/api)
40+
also have a community-maintained version with examples
41+
at [ClojureDocs](https://clojuredocs.org/).
3642

3743
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;
3844
only tutorials, guides, and linking to other relevant resources.
@@ -43,10 +49,10 @@ only tutorials, guides, and linking to other relevant resources.
4349

4450
CDS is structured as a number of guides. They broadly fall into 4 categories:
4551

46-
* [Tutorials](content/#clojure_tutorials)
47-
* [Language Guides](content/#clojure_language_guides)
48-
* [Ecosystem & Tools](content/#the_clojure_ecosystem)
49-
* [Cookbooks](content/#cookbooks)
52+
* [Tutorials](/articles/content/#clojure_tutorials)
53+
* [Language Guides](/articles/content/#clojure_language_guides)
54+
* [Ecosystem & Tools](/articles/content/#the_clojure_ecosystem)
55+
* [Cookbooks](/articles/content/#cookbooks)
5056

5157

5258
### Tutorials
@@ -62,29 +68,29 @@ Target audience: newcomers to the language.
6268
These guides are more in-depth, focused on various aspects of the language and interoperability.
6369
Examples of such guides include:
6470

65-
* Sequences
71+
* Collections & Sequences
72+
* Concurrency & Parallelism
6673
* Interoperability
67-
* Reference types
6874
* Laziness
69-
* Macros and compilation
75+
* Macros
7076

7177
Target audience: from developers who already have some familiarity with the language to those who have been using it for
7278
a while.
7379

7480

7581
### Tools & Ecosystem guides
7682

77-
These guides cover key Clojure ecosystem tools such as [Leiningen](http://leiningen.org), [Clojars](http://clojars.org), [REPLy](https://github.com/trptcolin/reply),
78-
[nREPL](https://github.com/clojure/tools.nrepl), [Emacs clojure-mode](https://github.com/technomancy/clojure-mode), VimClojure, [Counterclockwise](https://code.google.com/p/counterclockwise/), [La Clojure](http://plugins.jetbrains.com/plugin?pluginId=4050), etc. It also covers important ecosystem projects that are not tools: books,
79-
[ClojureSphere](http://www.clojuresphere.com/), [ClojureWerkz](http://clojurewerkz.org/), [Flatland](https://github.com/flatland) and so on.
83+
These guides cover key Clojure ecosystem tools such as [Leiningen](https://leiningen.org), [Clojars](https://clojars.org),
84+
[nREPL](https://nrepl.org), Emacs, vim, Calva, etc. It also covers important ecosystem projects that are not tools: books,
85+
communities, etc.
8086

8187
Target audience: all developers using or interested in the Clojure programming language.
8288

8389

8490

8591
### Cookbooks
8692

87-
Concise [Clojure example code](content/#cookbooks), categorized by subject.
93+
Concise [Clojure example code](/articles/content/#cookbooks), categorized by subject.
8894

8995

9096

@@ -106,7 +112,7 @@ If you find a mistake, poor grammar, an important topic not covered, or an outda
106112

107113
## Contributing
108114

109-
CDS uses [Cryogen](http://cryogenweb.org/). All tutorials and guides are written in Markdown.
115+
CDS uses [Cryogen](https://cryogenweb.org/). All tutorials and guides are written in Markdown.
110116

111117
The toolchain and setup process are described [in the README](https://github.com/clojure-doc/clojure-doc.github.io/blob/main/README.md#toolchain).
112118

content/md/articles/content.md

+1-8
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,6 @@ The Chlorine package for Clojure development in Atom (via a Socket REPL).
4040

4141
The user guide for Cursive, the Clojure plugin for IntelliJ.
4242

43-
### [Eclipse for Clojure Development](/articles/tutorials/eclipse/)
44-
45-
A brief introduction to Counterclockwise, a Clojure plugin for Eclipse.
46-
4743
### [Emacs for Clojure Development](/articles/tutorials/emacs/)
4844

4945
A brief introduction to Emacs, Clojure mode, CIDER and Clojure development workflow with Emacs.
@@ -56,9 +52,6 @@ A brief introduction to Clojure development in Vim with fireplace.vim.
5652

5753
The Calva extension for Clojure development in VS Code (via nREPL).
5854

59-
See also [Clover for VS Code](https://marketplace.visualstudio.com/items?itemName=mauricioszabo.clover)
60-
for Clojure development in VS Code (via a Socket REPL).
61-
6255

6356

6457
## Language Guides
@@ -382,7 +375,7 @@ This guide covers:
382375
## License
383376

384377
All the content is distributed under the
385-
[CC BY 3.0](http://creativecommons.org/licenses/by/3.0/) license
378+
[CC BY 3.0](https://creativecommons.org/licenses/by/3.0/) license
386379
and are copyright their respective primary author(s).
387380

388381

0 commit comments

Comments
 (0)