Skip to content

Adjustments to deps/Procurers reference. #544

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from

Conversation

owenRiddy
Copy link
Contributor

  • Have you read the guidelines for contributing?
  • Have you signed the Clojure Contributor Agreement?
  • Have you verified your asciidoc markup is correct?

= Justifications

  • Added a table, easier for readers to skim.
  • It can be unclear if a concept being referenced is a 3rd party one (like S3) or a Clojure one (like the root deps.edn). I tried to be specific with terminology and added some cross-references.
  • Outlining the coord keys in the Git procurer duplicates documentation in the Dependencies heading and obscures the fact that :git/url is optional. I think this is can be adequately covered with a cross-reference.

= Questions

There is a sentence in the reference that says "tools.deps.alpha is designed to support an extensible set of procurers that can expand over time". Is this something Clojure programmers expect to use & if so is there documentation or a tutorial on how to extend tools.deps.alpha with a new procurer that I can link? If it isn't a user-facing feature I'd like to prune that line.

What was "using the first attribute qualifier that's found (ignoring the reserved qualifier "deps") meant to be conveying & is it important? I scanned the source code and didn't see why a :deps key would be reserved in a coordinate.

= Future Work

The Procurers section talks about how to configure 3rd party software like S3 & Maven. If there isn't any push-back I'd like to move this into the Deps & cli guide, which would slim down the Procurer section. Then move the entire thing up near the top of the page near to where deps.edn is explained.

@puredanger
Copy link
Member

I've incorporated some of these comments on the page, along with many of my own modifications. It was difficult to separate all of those out so I haven't merged this directly, but I appreciate the push in improving this area of the docs.

@puredanger puredanger closed this Jun 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
2 participants