Open Atrium Documentation Sprint: Lots of updates
15 new and updated documentation topics for the latest Open Atrium release
Jeff and I recently wrapped up our #docsprint to add new and updated documentation for 15 different topics around the latest Open Atrium release. Whether you want to build a new feature for your Open Atrium project, customize it, or give it a fresh new look, there's now documentation explaining how to do it.
Here are the highlights.
- How to Build a New Feature
- What are Features and How They Help
- How Open Atrium Works and Main API Modules
- Development and Building Best Practices (work in progress)
- Create a Custom Sub-theme
- Customize Dashboards
We also specced out what documentation the Open Atrium project as a whole should have and posted it as the table of contents to the Open Atrium documentation book. You'll see that next to each item is its status and a note on whether a new or updated page is needed.
We plan to do another documentation sprint soon to knock out more from our list and add screenshots and links to related documentation from third party sites. We're also looking for people to contribute to Open Atrium documentation. If you're interested, check out the Documentation group on Community.OpenAtrium.com for more details.
References question
Lovely docs to accompany lovely software and design. Thanks.
I see that the bottom of your Notebook pages have a Views table listing ‘Referenced by’ (e.g. https://community.openatrium.com/documentation-en/node/449). What is generating the ‘referenced by’ data?
Thanks Moshe. If you’re
Thanks Moshe. If you’re logged in to community.openatrium.com and on a book page like that one, you’ll see “Reference this” on the right side of the secondary links of the page. That “Reference this” link and the table you refer to are handled by the xref module http://github.com/developmentseed/xref which comes w/ Open Atrium. Xref takes care of the UI and node reference is used for the storage. In the case of Open Atrium xref is configured to allow for quick blogging of documentation pages. It’s common in our internal workflow to write up a page in the notebook, whether documentation, a spec, a plan of action, etc., and then tell people about it by writing a blog post. Xref makes this quick and easy.
It’s outstanding work. Clear,
It’s outstanding work. Clear, specific, while giving a framework for understanding what’s happening. Very nice!