Aurelia Users Community Space Guides

Posted by Nikolaj Ivancic on February 11, 2018

Today, I'd like to invite a long-time Aurelia Community Member, Nikolaj Ivancic, to share a little bit about the "AUCS" community project that he's leading to help improve Aurelia's documentation. Take it away Nik!


The Aurelia Users Community Space (AUCS) Guides Project is the result of an effort by the Aurelia Users Community to address several important issues. I'd like to share a little bit about our goals, project status and how/why you should get involved...

  • Aurelia, as a platform, needs additional well-written guides, blogs, tutorials, code snippets, etc. particularly written by non-core team members. This is the primary work that AUCS team members are attempting, using the motto Aurelia developers for Aurelia developers.
  • The AUCS team wants to use its resources to address several initial problems for all Aurelia Framework "newbies", by addressing "higher level" topics than are currently covered by the official Aurelia guides , using the experience from working-through these same issues. This comes as a consequence of our belief that there is a relatively big difference between Framework Developers and Application Developers, despite the fact that there is an intersection between these two groups of people.
  • Our team is growing rapidly and desires to grow more so that we can deliver a lot of very well-written guides, blogs, tutorials, code snippets, architectural analyses, etc.
  • In order to ensure the best possible outcome of AUCS, the community members are being asked to participate in all decisions (via surveys that are currently posted at the Aurelia Discourse forum).
  • Our first deliverable - AUCS Portal , visually similar to the official Aurelia Website , was deployed in early January, only 6 days after the realization that we ought to have it to publish our materials continuously and without interference with the core team.
  • AUCS is completely independent from Aurelia proper and the core team, though we are in constant contact with Aurelia leadership. Such independence is the best way to create what we plan to do, without overloading the Aurelia leadership before we have substantial content to contribute.
  • All components of our "product line" are only a few weeks old and are therefore less mature than even an alpha.
  • If you are interested in more details of the AUCS Guides project please check the (still evolving) document describing the project internals - AUCS Project Guide (Note the difference between AUCS Guides project and AUCS Project Guide).

The AUCS website should be considered as the "aggregator and a transient station" between the Aurelia Community and the Aurelia Core Team. This means that it offers a buffer of content that's intended to eventually be moved to the Aurelia website, when ready. To further facilitate this, all of our data is formatted as markdown files - the AUCS website provides a structured interface to this data.

Here are a few related articles on the project's creation history:

We'd love for you to get involved! Please join The Aurelia Users Community Space and help us build the next set of great documentation for Aurelia!