This issue is to open a discussion regarding the layout and structure of the docs. During the monthly writer retreats over the summer, @laceysanderson and I hashed out a layout for the sidebar (ie. table of contents). The thought is to divide the docs into 3 major sections: User Documentation, Curation, File Upload and Management , and Administration Documentation. We chose to do this instead of sectioning by module, as this allows more intuitive navigation depending on who is using the module and their role in either administrating, curating or using the functionality. It is highly likely that a user does not need to know how to import data or install the module, and an administrator can just focus on what they need to know to configure the module.
NOTE: This is currently biased towards curation and the genotypes module specifically as those were the sections I was actively developing on at the time 🙈 So please make suggestions to fill in the blanks 😄
This issue is to open a discussion regarding the layout and structure of the docs. During the monthly writer retreats over the summer, @laceysanderson and I hashed out a layout for the sidebar (ie. table of contents). The thought is to divide the docs into 3 major sections: User Documentation, Curation, File Upload and Management , and Administration Documentation. We chose to do this instead of sectioning by module, as this allows more intuitive navigation depending on who is using the module and their role in either administrating, curating or using the functionality. It is highly likely that a user does not need to know how to import data or install the module, and an administrator can just focus on what they need to know to configure the module.
NOTE: This is currently biased towards curation and the genotypes module specifically as those were the sections I was actively developing on at the time 🙈 So please make suggestions to fill in the blanks 😄
Tripal Cultivate: Documentation
User Documentation
Curation, File Upload and Management
Administration Documentation