clojure-doc / clojure-doc.github.io Goto Github PK

The Emacs page is very outdated and there are likely better installation guides elsewhere.

The vim page talks about 2012 as "recently" but may still contain some useful information.

For now, remove these pages from the sidebar and unlink them from the main content. Provide a consolidated Editors page that provides key links to the four most popular editors and also some visualization tools.

Language should be basic but clear reference material?

Tutorials should be step-by-step introductory material?

Cookbooks should be able to assume relevant Language and Tutorials have been covered and should build on that?

Expand on the official guide, based on the sorts of things in my OSS projects (and any other interesting ones out there -- make a call for suggestions!).

Ensure the information in the README is up-to-date, accurate, and clear.

Add a link to Clojurists Together 2023 information.

Add notes/links about Discussions and adding Issues.

Perhaps point at https://github.com/seancorfield/deps-new/blob/develop/resources/org/corfield/new/lib/root/pom.xml

Asked for feedback on Slack in the #core-typed channel.

See #18

Write up Phase 2 progress and report to Clojurists Together.

On page https://clojure-doc.org/articles/tutorials/getting_started/

Under section "See Also"

The url for "Starting Clojure screencast" http://cemerick.com/2012/05/02/starting-clojure/ is no longer accessible.

Phronmophobic on Slack: use more bullet points instead of prose/run-on sentences. https://clojurians.slack.com/archives/C8NUSGWG6/p1687928614580569?thread_ts=1687926033.501479&cid=C8NUSGWG6

While you can have artifact-classifier-version.jar (and depend on it via group/artifact$classifier), a common mistake might be to upload the -standalone (or some other-named JAR) and the deploy will "work" but people won't be able to depend on your lib.

Should talk to @slipset about maybe making deps-deploy do some additional checking there, or maybe even renaming?

i.e. the link to https://clojure-doc.github.io/articles/ecosystem/core_typed/home/rationale/ leads to a 404, as do other links deeper than /home/ on this page: https://clojure-doc.github.io/articles/ecosystem/core_typed/home/

Write up Phase 1 progress and report to Clojurists Together.

The empty pages (Data structures, Date and Time, and Data Processing) (some of which happened to show up early in the TOC) leave an impression of an unfinished project

Should this just defer to something else?

At a minimum, remove outdated libraries and add modern equivalents.

Review/remove outdated content.

Update the remaining sections that will be kept.

Likely candidates for removal:

• ❌ Ecosystem > Data Processing (it's been empty ever since it was created)
• ❌ Ecosystem > Maven (hardly anyone builds Clojure projects this way any more)
• ❌ Tutorials > Emacs & Vim Fireplace (both very outdated and there are better, more up-to-date guides elsewhere)

Sections to keep that need a lot of work:

• ✅ Ecosystem > Generating Documentation
• ✅ Ecosystem > Web Development

Sections to keep that need wordsmithing:

• ✅ Tutorials > Introduction (to Clojure)

Ensure that the Klipse notes are up-to-date, accurate, and clear.

Review files that have Klipse enabled to check things still work.

This is not easy to find and should be woven into the earlier introduction material https://clojure-doc.org/articles/ecosystem/libraries_authoring/#creating-new-projects

Make sure all sidebar sections are mentioned in content.md in the same order.

Review all the :sidebar-omit? true pages and see if they need adding to content.md (or removing)?

Write up Phase 4 progress and report to Clojurists Together.

I’d like to discuss with you guys about the idea of integrating Klipse in order to feature interactive code snippets in clojure-doc.github.io

Write up Phase 3 progress and report to Clojurists Together.

If you generate a pom.xml from "scratch" with tools.deps, it includes modelVersion and packaging. The former is required according to the Maven spec and dependency management seems to misbehave when it is missing.

If you specify :src-pom, then tools.deps does not add modelVersion or packaging so your template must include them.

If you specify :pom-data instead, then it is purely additive to what tools.deps would create by default, so modelVersion and packagaing are added.

The cookbook should mention this important difference.

We need clear guidance on CLI/deps.edn as well as Leiningen with some impartial discussion of both.

Perhaps remove data structures and date/time sections since they've been empty for a long time.

Review/update the others.

Use next.jdbc instead of outdated java.jdbc (and remove other links to java.jdbc -- but leave core pages since they are linked from the java.jdbc Contrib repo).

Hi.
Not sure if this is a "real" issue, but when I'm trying to follow "Basic web" tutorial and when I update all dependencies in deps.edn to current versions, I receive such warning:

> clojure -M -m basic-web.handler
SLF4J: No SLF4J providers were found.
SLF4J: Defaulting to no-operation (NOP) logger implementation
SLF4J: See https://www.slf4j.org/codes.html#noProviders for further details.

But web server runs, I can open localhost:3000 in browser and it works as expected.
Still I don't receive any other information inside console, just that warning.

After trying different things I found that this happens when I use 1.11.0 version of ring-core and ring-jetty-adapter.
Even with 1.10.0 version everything works as expected.

To fix this and make it work we need to add org.slf4j/slf4j-simple {:mvn/version "2.0.11"}(current version) as additional dependency inside deps.edn.
After that we'll see expected info messages and no warnings:

> clojure -M -m basic-web.handler
[main] INFO org.eclipse.jetty.server.Server - jetty-11.0.18; built: 2023-10-27T02:14:36.036Z; git: 5a9a771a9fbcb9d36993630850f612581b78c13f; jvm 21.0.2+13-LTS
[main] INFO org.eclipse.jetty.server.handler.ContextHandler - Started o.e.j.s.ServletContextHandler@1f207142{/,null,AVAILABLE}
[main] INFO org.eclipse.jetty.server.AbstractConnector - Started ServerConnector@76ebd595{HTTP/1.1, (http/1.1)}{0.0.0.0:3000}
[main] INFO org.eclipse.jetty.server.Server - Started Server@74ed7111{STARTING}[11.0.18,sto=0] @3017ms

Not sure if this is a correct solution, but I think it should be mentioned somewhere that we shouldn't change versions or information how to fix this in correct way should be added.

P.S.: Every other dependencies were updated to current versions, but only release ones without alpha/beta/etc.

Write up Phase 6 progress and report to Clojurists Together.

Write up Phase 5 progress and report to Clojurists Together.

Please refer to my terrible diagram.

Remove outdated editions. Verify/update every link.

Put out request for missing books to be listed.