Skip to content
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

Better repository/examples layout #10

Open
paddycarey opened this issue Mar 15, 2019 · 1 comment
Open

Better repository/examples layout #10

paddycarey opened this issue Mar 15, 2019 · 1 comment

Comments

@paddycarey
Copy link
Contributor

How can we better organise the examples in the repository to make them easier to navigate and find?

Do we add an extra level of organisation and group examples by language/format with sub-folders for tooling types? e.g. examples/python/cli instead of examples/python-cli

@lskillen
Copy link
Member

lskillen commented Mar 15, 2019

I think the following structure makes sense (so we can link it from on-site easily):

/examples/
  /<package-format>/
    /<build-system>/
      /<method/type>/

E.g. For Maven it might be something like:

/examples/maven/maven/cloudsmith-cli/
/examples/maven/maven/native/
/examples/maven/maven/wagon/
/examples/maven/leiningen/cloudsmith-cli/
/examples/maven/leiningen/native/
/examples/maven/leiningen/wagon/
/examples/maven/sbt/cloudsmith-cli/
/examples/maven/sbt/wagon/
/examples/maven/sbt/native/

Each level will require a README.md to point users in the right direction (just examples):

/examples/maven/README.md:

# Language

## Scala

The "sbt" directory provides examples for building, uploading and retrieving packages using sbt.
/examples/maven/sbt/README.md:

# Sbt Version

## 0.x

Versions before 1.x require the use of the <link>Cloudsmith Maven Wagon</link> in order to upload packages. The "wagon" directory provides an example of integrating with Cloudsmith, and will allow you to use the native "sbt publish" functionality. You can also use the Cloudsmith CLI instead, as shown in the "cloudsmith-cli" example.
/examples/maven/sbt/native/README.md

# How To Build

You can build the sbt native project by doing the following:

Comments on a post card. :-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

2 participants