[jboss-jira] [JBoss JIRA] (DROOLS-1506) drools-docs improvements: file structure, dead images, etc

[Geoffrey De Smet (JIRA)]

     [ https://issues.jboss.org/browse/DROOLS-1506?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Geoffrey De Smet updated DROOLS-1506:
-------------------------------------
    Description: 
See latest docs here from jenkins:
   https://kie-jenkins.rhev-ci-vms.eng.rdu2.redhat.com/job/kie-docs/lastSuccessfulBuild/artifact/docs/drools-docs/target/generated-docs/html_single/index.html


- 4 mentions of KnowledgeSession (5.x api) should be replaced by KieSession (6 & 7 api). Same for KnowledgeBase, etc.
  Do a find in single_html output for regex "Knowledge\w".

- Chapter 3 Compatibility matrix is 4 lines, should be a nested section in another chapter

- Dead images.

- Dead sections?

- Images in differently named directory than their section adoc.
  For example: images in directory GettingInvolved in shared-kie-docs

- Release notes should not reuse images from rest of docs,
  because those images get updated over time
  and release notes should not change retroactively automatically.
  Copy-paste those images in the release notes directories instead of reusing them.

- Every section header needs an anchorId. All existing anchorIds need to be cleaned up. CamelCase to match filenames.


  was:
See latest docs here from jenkins:
   https://kie-jenkins.rhev-ci-vms.eng.rdu2.redhat.com/job/kie-docs/lastSuccessfulBuild/artifact/docs/drools-docs/target/generated-docs/html_single/index.html


- 4 mentions of KnowledgeSession (5.x api) should be replaced by KieSession (6 & 7 api). Same for KnowledgeBase, etc.
  Do a find in single_html output for regex "Knowledge\w".

- Chapter 3 Compatibility matrix is 4 lines, should be a nested section in another chapter

- Dead images.

- Dead sections?

- Images in differently named directory than their section adoc.
  For example: images in directory GettingInvolved in shared-kie-docs

- Release notes should not reuse images from rest of docs,
  because those images get updated over time
  and release notes should not change retroactively automatically.
  Copy-paste those images in the release notes directories instead of reusing them.

- Every section header needs an anchorId.




> drools-docs improvements: file structure, dead images, etc
> ----------------------------------------------------------
>
>                 Key: DROOLS-1506
>                 URL: https://issues.jboss.org/browse/DROOLS-1506
>             Project: Drools
>          Issue Type: Task
>          Components: docs
>    Affects Versions: 7.0.0.Beta8
>            Reporter: Geoffrey De Smet
>
> See latest docs here from jenkins:
>    https://kie-jenkins.rhev-ci-vms.eng.rdu2.redhat.com/job/kie-docs/lastSuccessfulBuild/artifact/docs/drools-docs/target/generated-docs/html_single/index.html
> - 4 mentions of KnowledgeSession (5.x api) should be replaced by KieSession (6 & 7 api). Same for KnowledgeBase, etc.
>   Do a find in single_html output for regex "Knowledge\w".
> - Chapter 3 Compatibility matrix is 4 lines, should be a nested section in another chapter
> - Dead images.
> - Dead sections?
> - Images in differently named directory than their section adoc.
>   For example: images in directory GettingInvolved in shared-kie-docs
> - Release notes should not reuse images from rest of docs,
>   because those images get updated over time
>   and release notes should not change retroactively automatically.
>   Copy-paste those images in the release notes directories instead of reusing them.
> - Every section header needs an anchorId. All existing anchorIds need to be cleaned up. CamelCase to match filenames.



--
This message was sent by Atlassian JIRA
(v7.2.3#72005)