You are viewing a plain text version of this content. The canonical link for it is here.

Posted to dev@aurora.apache.org by Kevin Sweeney <ke...@apache.org> on 2014/10/15 02:06:05 UTC

Themes for Aurora documentation sprint

Hi all,

Thanks for your interest in the documentation sprint so far, keep those
tickets coming. Here are some themes I think we should address, if any of
them interest you please volunteer by checking the JIRA Documentation
<https://issues.apache.org/jira/browse/AURORA/component/12321704/>
component and assigning the relevant ticket to yourself. If no ticket
exists yet, please feel free to create one. Please also feel free to
suggest additional themes on this thread.

Themes

   - Undocumented Features
      - Cron
      - Service Discovery
      - Your feature here.
   - Deployment and Monitoring
      - High-level component overview
      - Monitoring - what metrics are available
      - Performance tuning - what flags are available and which metrics
      might suggest changing them
      - SLA
   - Automatic API documentation
      - Auto-publish Javadoc, sphinx docs, IDL docs
   - Extension Mechanisms w/ Examples
      - Binding Helpers
      - Hooks
      - Mixin Processes
   - Best Practices
   - Meta
      - Structure and organization of documentation and website
      - Versioned documentation on website?