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

how to organize source vs. compiled vs. docs #5

Open
jonschlinkert opened this issue Jul 17, 2013 · 0 comments
Open

how to organize source vs. compiled vs. docs #5

jonschlinkert opened this issue Jul 17, 2013 · 0 comments

Comments

@jonschlinkert
Copy link
Member

I'm trying to decide how to organize components. I do know this much:

  • each component gets it's own repo
  • each component will also be showcased on the gh-pages for upstage/components

Here are some ideas, any of these can change based on feedback:

  • In the repo for each component, only the compiled CSS/HTML/JavaScript for the component will be in the master branch.
  • Absolute minimalist templates, data files (JSON/YML), LESS/SASS etc. can also go in the master branch, but the "main" files in bower.json will always be CSS/HTML/JavaScript.
  • All documentation for the component goes in the readme of the master branch. Then what I'd like to figure out is how to grab a specific section of content from each readme to use in the documentation on upstage/components

Component Examples:

  • The gh-pages for each component can show a basic example of the component, or
  • upstage/components will showcase the component, then we just add a screenshot of each component to the readme of the component with "To see this live, click here" or whatever. I kind of like this because it reduces maintenance and keeps us working on ways to make it easy to consume components (since each new component would need to be added to upstage/components)

cc @upstage/core-team

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

No branches or pull requests

1 participant