Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Look at all the great documentation we've already got  
    1. Highlighting fact we have groups bringing documentation - here's some examples of how it's done
  2. Continued effort to consolidation of documentation
    1. streamline communication for getting content into the site:  Reaching out to newly designated owners of certain repos to make sure that happens
  3. Next Steps:  What we need for resources from community
    1. An actual sprint dedicated to the documentation - 2 weeks of working on documentation
    2. Less to do with content and more to making content easier to manage
    3. Lay out technical things for developers to solve 

Set up a project board for structure and one project board for documentation efforts - Technical Board and Content Board

Challenge of getting FTE time.  Have 5 developers doing 4 hours per week.  (20 hrs.)  But has to be well organized.  Tickets doable within 4 hours.  Pushing and asking for someone willing to take an organizational role a requirement for a successful sprint.  

Lynette - firmed that up and placed her notes in Slack.

Seques into general org of site:

Haven't done work toward versioning  - only difference between work Drew was looking at and what Lynette had done.  Doesn't change theory of how this is documented.  

Site is organization wide - all of Samvers, not just Hyrax.  title of site is Hyrax Developer Knowledgebase.  More product centered and therefore version centered?  

When we've been implementing version metadata - it's been Hyrax.  Specifiying a version of Hyrax.  An excellent organizational approach.  At highest level - we jump into weeds right away.  Can have different menus in current framework.  Could have an Avalon left hand menu/ Hyrax Lefthand menu/ Shared Lefthand menu.  

First level - what flavor you want to look at, then product, then versioning below that

The flexibility makes code a lot messier.  Top level generic - Smavera COmmunity - general repository up there.  maybe a blog.  Drill down process.  Then product.  Then version.  Doesn't all have to be in left menu.  Theme taken from Jekyll how-to guides - so not married to current theme.  We could bust out of it if we wanted to.  


Check into next time:Didn't get to HTML proofer - still a lot of broken images according to proofer

Blog:  Talk about at LDCX - we don't have a way to find and coordinate blog posts from community - we could collect some of that stuff scattered around the community.  


  1. Facilitator & Notetaker for next meeting
    1. Facilitator:  Drew
    2. Notetaker:  Ryan

Action items 

  •