[ https://issues.apache.org/jira/browse/OFBIZ-10251?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16394159#comment-16394159 ]
Michael Brohl commented on OFBIZ-10251: --------------------------------------- Hi Sharan, all, I just wanted to start to create the documents for subtask OFBIZ-10245 but get stuck with the naming. I'd prefer to have a consistent naming schema for the files as follows: # human-resources.adoc # hr-intro.adoc # hr-employee-evaluations.adoc # hr-glossary.adoc # hr-employee-positions.adoc # hr-employees.adoc # hr-employments.adoc # hr-performance-review.adoc # hr-positions.adoc # hr-qualifications.adoc # hr-recruitment.adoc # hr-skills.adoc # hr-resumes.adoc # hr-training.adoc # hr-leave.adoc # hr-security.adoc # hr-global-settings.adoc I don't want to break things which might be discussed/agrred upon already so better ask if this naming-schema ist ok. Additionally, I'd propose to keep a consistent naming schema throughout all components where applicable. e.g. * component(module name), separated by dashes for the main document (human-resources.adoc) * a short name for every included page in the _include folder (hr-*.adoc) * consistent naming for similar pages like intro, glossary, FAQ, settings, security ([shortname]-intro, [shortname]-glossary, [shortname]-faq, [shortname]-settings, [shortname]-security etc.) So for the party manager this would be # party-manager.adoc # party-intro.adoc # party-glossary.adoc # party-faq.adoc # party-settings.adoc # party-security.adoc # etc. This could give people a guideline for the base structure and you can immediately recognize what the file contains. What do you think? > Move Human Resources Guide into OFBiz Asciidoc Framework > -------------------------------------------------------- > > Key: OFBIZ-10251 > URL: https://issues.apache.org/jira/browse/OFBIZ-10251 > Project: OFBiz > Issue Type: Task > Reporter: Sharan Foga > Priority: Minor > Labels: documentation, humanres > > This is a general umbrella issue for managing the creation and migration of > all OFBiz related Human Resources documentation into the OFBiz code base. > Subtasks will be created for each of the documents that need to be created. > Also created as a sub task will the task to create empty documents for each > of the sub-files in the list > An initial list is as follows: > # human-resources.adoc > # human-resources-intro.adoc > # employee-evaluations.adoc > # human-resources-glossary.adoc > # employee-positions.adoc > # employees.adoc > # employments.adoc > # performance-review.adoc > # positions.adoc > # qualifications.adoc > # recruitment.adoc > # skiils.adoc > # resumes.adoc > # training.adoc > # leave.adoc > # human-resources-security.adoc > # human-resources-global-settings.adoc > -- This message was sent by Atlassian JIRA (v7.6.3#76005)