Moving to SassDoc organisation #70

Closed
HugoGiraudel opened this Issue Jul 8, 2014 · 16 comments

Comments

Projects
None yet
4 participants
@HugoGiraudel
Member

HugoGiraudel commented Jul 8, 2014

What about having a SassDoc organisation on GitHub, gathering the following repositories:

  • SassDoc
  • grunt-sassdoc
  • ScssCommentParser
  • CDocParser (?)
  • SassCommentParser some day?
  • Sooner or later, SassDoc-default-theme
  • And every other available themes.
@valeriangalliat

This comment has been minimized.

Show comment
Hide comment
@valeriangalliat

valeriangalliat Jul 8, 2014

Member

I agree.

For the packages names, I think a lowercase notation with dashes could make the naming consistent.

  • sassdoc (like in package.json)
  • grunt-sassdoc
  • scss-comment-parser (like in package.json I guess?)
  • ...
  • sassdoc-theme-default (sassdoc-theme- prefix for all themes would be great)

Every official theme would be in the organisation but anyone could create its own theme and publish it on npm without it to be in SassDoc organisation.

Member

valeriangalliat commented Jul 8, 2014

I agree.

For the packages names, I think a lowercase notation with dashes could make the naming consistent.

  • sassdoc (like in package.json)
  • grunt-sassdoc
  • scss-comment-parser (like in package.json I guess?)
  • ...
  • sassdoc-theme-default (sassdoc-theme- prefix for all themes would be great)

Every official theme would be in the organisation but anyone could create its own theme and publish it on npm without it to be in SassDoc organisation.

@HugoGiraudel

This comment has been minimized.

Show comment
Hide comment
@HugoGiraudel

HugoGiraudel Jul 8, 2014

Member

Actually, it's scsscommentparser in package.json. But, ScssCommentParser is still not in v1 either, so I guess we could rename the package.

Member

HugoGiraudel commented Jul 8, 2014

Actually, it's scsscommentparser in package.json. But, ScssCommentParser is still not in v1 either, so I guess we could rename the package.

@pascalduez

This comment has been minimized.

Show comment
Hide comment
@pascalduez

pascalduez Jul 8, 2014

Member

Seems legit, and a good move in many aspects.
Also streamlining repo/packages names, since they are node stuff anyway.

Member

pascalduez commented Jul 8, 2014

Seems legit, and a good move in many aspects.
Also streamlining repo/packages names, since they are node stuff anyway.

@HugoGiraudel

This comment has been minimized.

Show comment
Hide comment
@HugoGiraudel

HugoGiraudel Jul 8, 2014

Member

Waiting for @FWeinb opinion on this.

Member

HugoGiraudel commented Jul 8, 2014

Waiting for @FWeinb opinion on this.

@HugoGiraudel HugoGiraudel self-assigned this Jul 9, 2014

@FWeinb

This comment has been minimized.

Show comment
Hide comment
@FWeinb

FWeinb Jul 9, 2014

Member

Lets to this. I am good with renaming things. But CDocParser should be standalone.

Member

FWeinb commented Jul 9, 2014

Lets to this. I am good with renaming things. But CDocParser should be standalone.

@HugoGiraudel

This comment has been minimized.

Show comment
Hide comment
@HugoGiraudel

HugoGiraudel Jul 9, 2014

Member

But CDocParser should be standalone.

Agreed.

Member

HugoGiraudel commented Jul 9, 2014

But CDocParser should be standalone.

Agreed.

@HugoGiraudel

This comment has been minimized.

Show comment
Hide comment
@HugoGiraudel

HugoGiraudel Jul 9, 2014

Member

SassDoc organisation?

Member

HugoGiraudel commented Jul 9, 2014

SassDoc organisation?

@HugoGiraudel

This comment has been minimized.

Show comment
Hide comment
@HugoGiraudel

HugoGiraudel Jul 9, 2014

Member

Done.

@FWeinb, if you want to move ScssCommentParser, be my guest.
@pascalduez, if you want to move grunt-sassdoc, be my guest.

Member

HugoGiraudel commented Jul 9, 2014

Done.

@FWeinb, if you want to move ScssCommentParser, be my guest.
@pascalduez, if you want to move grunt-sassdoc, be my guest.

@valeriangalliat

This comment has been minimized.

Show comment
Hide comment
@valeriangalliat

valeriangalliat Jul 9, 2014

Member

The organisation is okay, but I reopen this issue to continue the discussion about repositories naming conventions.

As I already said, it would be a good idea to keep a standard naming for all repositories. Since npm packages are lower case with dashes (and same for a lot of package systems), we can rename all the repositories to match this convension.

GitHub will redirect old URLs so this won't be a problem.

So if everybody is okay, I propose to rename:

  • SassDoc to sassdoc,
  • SassDoc-cli to sassdoc-cli,
  • ScssCommentParser to scsscommentparser.

The last one is kinda not readable all lowercase though, maybe scss-comment-parser would be a better name? The problem is this one already have its npm package...

Member

valeriangalliat commented Jul 9, 2014

The organisation is okay, but I reopen this issue to continue the discussion about repositories naming conventions.

As I already said, it would be a good idea to keep a standard naming for all repositories. Since npm packages are lower case with dashes (and same for a lot of package systems), we can rename all the repositories to match this convension.

GitHub will redirect old URLs so this won't be a problem.

So if everybody is okay, I propose to rename:

  • SassDoc to sassdoc,
  • SassDoc-cli to sassdoc-cli,
  • ScssCommentParser to scsscommentparser.

The last one is kinda not readable all lowercase though, maybe scss-comment-parser would be a better name? The problem is this one already have its npm package...

@FWeinb

This comment has been minimized.

Show comment
Hide comment
@FWeinb

FWeinb Jul 9, 2014

Member

👍

Member

FWeinb commented Jul 9, 2014

👍

@pascalduez

This comment has been minimized.

Show comment
Hide comment
@pascalduez

pascalduez Jul 9, 2014

Member

Fine, let's lowercase all the packages.

Member

pascalduez commented Jul 9, 2014

Fine, let's lowercase all the packages.

@valeriangalliat

This comment has been minimized.

Show comment
Hide comment
@valeriangalliat

valeriangalliat Jul 9, 2014

Member

@HugoGiraudel, I wait your confirmation. :)

Any idea for scsscommentparser/scss-comment-parser too?

Member

valeriangalliat commented Jul 9, 2014

@HugoGiraudel, I wait your confirmation. :)

Any idea for scsscommentparser/scss-comment-parser too?

@pascalduez

This comment has been minimized.

Show comment
Hide comment
@pascalduez

pascalduez Jul 9, 2014

Member

Any idea for scsscommentparser/scss-comment-parser too?

Yep, not much options here. I guess scss-comment-parser is fine.

Member

pascalduez commented Jul 9, 2014

Any idea for scsscommentparser/scss-comment-parser too?

Yep, not much options here. I guess scss-comment-parser is fine.

@valeriangalliat

This comment has been minimized.

Show comment
Hide comment
@valeriangalliat

valeriangalliat Jul 9, 2014

Member

If we do so, we need to rename the npm pakcage too. I hope this won't break too much dependencies!

Member

valeriangalliat commented Jul 9, 2014

If we do so, we need to rename the npm pakcage too. I hope this won't break too much dependencies!

@HugoGiraudel

This comment has been minimized.

Show comment
Hide comment
@HugoGiraudel

HugoGiraudel Jul 9, 2014

Member

Let's do this.

Also, scss-comment-parser. It's still not in v1 and is only used by us. No problem with renaming the package.

Member

HugoGiraudel commented Jul 9, 2014

Let's do this.

Also, scss-comment-parser. It's still not in v1 and is only used by us. No problem with renaming the package.

@HugoGiraudel

This comment has been minimized.

Show comment
Hide comment
@HugoGiraudel

HugoGiraudel Jul 9, 2014

Member

I renamed all repositories. We need @FWeinb to rename his package and update the dependency.

Member

HugoGiraudel commented Jul 9, 2014

I renamed all repositories. We need @FWeinb to rename his package and update the dependency.

@HugoGiraudel HugoGiraudel assigned FWeinb and unassigned HugoGiraudel Jul 9, 2014

@HugoGiraudel HugoGiraudel changed the title from Moving to SassDoc organisation? to Moving to SassDoc organisation Jul 9, 2014

@FWeinb FWeinb closed this in 1a964d5 Jul 10, 2014

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