V-Squared / V-Squared.github.io

Initiative for Modular and Upgradable Mini and All-In-One PC. Standards — Know How — Blueprints — Trailblazer Products
http://v-squared.github.io/
Other
2 stars 1 forks source link

Epic►003►Move Plan Articles to V-Squared.github.io #106

Closed VillageHubertChen closed 8 years ago

VillageHubertChen commented 8 years ago

The structure of our web site before this issue has one repository for each Board (V²Site is using a Library Shelf Metaphor. The top level sections of our site are called Boards). This had advantages when we started. But now that we are using Jekyll we realize that Jekyll can not cleanly support this structure. It would lead to duplicating code nine times for nine boards, which is a developer's night mare. As such we need to consolidate all nine board repositories into one, which is V-Squared.github.io.

Increase Contribution Statistics

We are are an Open Source Project on GitHub who benefit from contributors. The first thing many contributors do when evaluating a project on GitHub is to check out: Graphs and Pulse. Before this restructure our statistics looked like we are not active, because all our work happened in the other nine repositories. After this consolidation our statistics will look much more alive, as such much more attractive to potential contributors.

Order of Content Development

S1: V²Plan

Our focus is to gain speed and we are doing this by adding contributors. We just added 3 more contributors this week: Bobby, Tom and Karen. In order to continue working together we need:

  1. Clear description of our Targets
  2. A clear Road Map how to reach these Targets
  3. A Dashboard that is managing our Sprints
  4. A System that makes using all of the above consistent
  5. Documentation on how to use all of the above

V²Plan delivers all of the above.

S2: Spreading

Bobby's first work is to write the DIY and Configuration Articles. They are located in the Spreading Board. To provide him the necessary tools to work we have to finish this Board ASAP.

S3: Products

The V² Products Board is the incubation chamber for product pages used in our ViSite as well as V²Shop-Midwest. Currently we are building a lot of documentation technical debt, marked by labels: o.debt.docu . Once we have the Products Board ready, we can instantly move documentation to there without creating more technical debt

S4: Organization

Potential V² contributors as well as potential V²Shop customers checking us out will also want to learn more about us. This is published in the Board Organization.

VillageHubertChen commented 8 years ago

All steps: Plan → V-Squared.github.io

VillageHubertChen commented 8 years ago

New Jekyll Folder Structure

v-squared.github.io
  ├ _data
  │   ├ boardBar.yml
  │   ├ standards-bookBar.yml
  │   ├ products-bookBar.yml
  │   ┊
  │   ├ organization-bookBar.yml
  │   └ repository.json (List of all repositories, used in home page and in footer for every page)
  │
  ├ _includes
  │   ├ article-bar.html
  │   ├ contents-bar.html
  │   ├ footer.html
  │   ├ head.html (HTML head)
  │   ├ board-bar.html
  │   └ book-bar.html
  │
  ├ _javascript
  │   ├ controllers
  │   ├ dependencies
  │   └ directives
  │
  ├ _layouts
  │   ├ default.html
  │   ├ home.html
  │   ├ page.html
  │   └ post.html
  │
  ├ _post (contains all blog posts)
  │   ┊
  ├ _sass
  │   ┊
  ├ css
  │   ┊
  ├ fonts
  │   ┊
  ├ icons
  │   ┊
  ├ standards (board folder)
  │   ┊
  ├ products (board folder)
  │   ┊
  ├ makers (board folder)
  │   ┊
  ├ diy (board folder)
  │   ┊
  ├ retail (board folder)
  │   ┊
  ├ spreading (board folder)
  │   ┊
  ├ apps (board folder)
  │   ┊
  ├ Plan  (board folder)
  │   ├ system (book folder)
  │   ├ road-map (book folder)
  │   ├ contributing.md (article on book level)
  │   ├ dashboard.md (article on book level)
  │   ├ target.md (article on book level)
  │   ├ system.md (Intro Article to series in System Book)
  │   ├ road-map.md (Intro Article to series in Road Map Book)
  │   └ index.md (Intro Article to Plan Board)
  │
  ├ organization
  ├ _config.yml (Global configuration of this site, such as site name, etc ...)
  ├ feed.xml
  ├ README.md
  ├ .gitognore
  └ index.html
LukasChen commented 8 years ago

Problems of moving v-squared.github.io

Everything in intro is in the index.html file