-
Notifications
You must be signed in to change notification settings - Fork 2
Content Hierarchy
These categories appear in the primary navigation and represent the root folders for source files:
- Getting Started
- Concepts
- Guides
- Community
- Releases
In addition to these categories, the docs root is a "landing page." It features a prominent link to the Getting Started category, as well as links and descriptions for the other categories. It is also the place to indicate important changes or news related to the documentation (e.g., future reorganizations, highlight for new documentation, new release info, etc.).
Anything relevant to Symphony beginners who literally want to find out how to set up and create a Symphony site.
Pages:
- Installing Symphony
- Upgrading Symphony
- Walkthrough of the default "example" workspace bundled with Symphony
- Installing Extensions
Information pages that describe the concepts around which Symphony is organized, as well as the components used to build a Symphony site. Pages in this category should be descriptive; if you want to teach people how to do something with these, you probably want to write a Guide. This category's purpose is to keep the docs DRY—we can link to the pages herein from tutorials.
Pages/Subcategories: See the Concepts section of the Symphony Learn site.
Tutorials, articles, and any other resource that aims to teach people how to do something with Symphony.
Subcategories:
-
Articles
These explain more complicated concepts, philosophies, or common practices with Symphony. Unlike tutorials, they are not so focused on achieving a specific goal as they describing an idea.
-
Screencasts
These are tutorial videos. Where necessary, pages will need errata to describe changes to Symphony since the version that appears in the screencast.
-
Tutorials
These are walkthroughs that demonstrate how to achieve something using a series of steps a reader can follow. They may or may not include associated ensembles, Git repos, or screencasts. Depending on the length and complexity of these tutorials, items in this subcategory might be broken into multiple pages.
Information about the wider Symphony community, such as the important Symphony-related sites, and how people can get help or contribute.
Pages:
-
Root page
Likely the best place to list links to other sites—e.g., forum, GitHub, SymphonyExtensions.com, etc.
-
Contributing to Symphony
Information on best practices for contributing to the core and/or developing and releasing extensions. (Note that how to develop an extension is best left to a tutorial, but how to let people know about extensions, maintaining them, etc., would belong here.) Probably should include Symphony's coding style guidelines, either on the page or as a sub-page.
-
Contributing to the Docs
Information on how to contribute to this documentation. Should link to Jekyll documentation, the docs repo, etc. Should include our style guide, either on the page or as a sub-page.
Information pertinent to specific releases of Symphony, organized by version number. This includes the developer notes that currently live on the repo wiki.