Skip to content
This repository has been archived by the owner on Jul 10, 2024. It is now read-only.

Create the basic structure for a new documentation of jQAssistant #7

Closed
obfischer opened this issue May 26, 2019 · 1 comment
Closed

Create the basic structure for a new documentation of jQAssistant #7

obfischer opened this issue May 26, 2019 · 1 comment
Assignees
@obfischer
Labels
status:done All work related to this issue has been done topic:documentation Changes or enhancements to the documentation are necessary for this issue type:task A piece of work that must be done, but does not represent a noticeable change for the user
Milestone
1.9.0

Comments

@obfischer
Copy link
Contributor

We would like to provide a better documentation to the users of jQAssistant. Therefore we decided to write a new user guide and an additional reference manual.

Therefore we need to setup the basic structure for both documents parallel to the existing documents.
@obfischer obfischer modified the milestone: 1.6.0 May 26, 2019
@obfischer obfischer pinned this issue May 26, 2019
obfischer added a commit that referenced this issue May 26, 2019
@obfischer
[#7] Added the basic structure for the userguide as well as a very ba…
ed4b33c 
…sic initial document for the reference.
obfischer added a commit that referenced this issue May 26, 2019
@obfischer
[#7] Turned numbering of captions on and added some empty chapters to…
6398adc 
… the reference manual
@obfischer obfischer self-assigned this May 26, 2019
obfischer added a commit that referenced this issue Jun 19, 2019
@obfischer
[#7] Small changes and fixes
5e1cb45
@obfischer obfischer added this to the 1.8.0 milestone Nov 16, 2019
@obfischer obfischer added topic:documentation Changes or enhancements to the documentation are necessary for this issue type:task A piece of work that must be done, but does not represent a noticeable change for the user labels Nov 17, 2019
@obfischer obfischer modified the milestones: 1.8.0, 1.9.0 Feb 6, 2020
@obfischer obfischer added status:in progress A human being is working on this problem and removed status:in progess labels Feb 10, 2020
obfischer added a commit to jqassistant-archive/jqa-uber-parent that referenced this issue Feb 18, 2020
@obfischer
[jqassistant-archive/jqa-manual#7] Added Maven Antrun Plugin to the l…
6a7619f 
…ist of managed plugins
obfischer added a commit to jqassistant-archive/jqa-asciidoc-report-plugin that referenced this issue Oct 14, 2020
@obfischer
[jqassistant-archive/jqa-manual#7 Assigned an id to the toplevel head…
d190578 
…line, so what it can be easily referened from the jQAssistant Reference
obfischer added a commit to jqassistant-archive/jqa-cdi-plugin that referenced this issue Oct 16, 2020
@obfischer
[jqassistant-archive/jqa-manual#7] Assigned an id to the toplevel hea…
2e30508 
…dline, so what it can be easily referened from the jQAssistant reference
obfischer added a commit to jqassistant-archive/jqa-junit-plugin that referenced this issue Oct 16, 2020
@obfischer
[jqassistant-archive/jqa-manual#7] Assigned an id to the toplevel hea…
5cf0340 
…dline, so what it can be easily referened from the jQAssistant reference
obfischer added a commit to jqassistant-archive/jqa-osgi-plugin that referenced this issue Oct 16, 2020
@obfischer
[jqassistant-archive/jqa-manual#7] Assigned an id to the toplevel hea…
83611b4 
…dline, so what it can be easily referened from the jQAssistant reference
obfischer added a commit to jqassistant-archive/jqa-yaml2-plugin that referenced this issue Oct 16, 2020
@obfischer
[jqassistant-archive/jqa-manual#7] Assigned an id to the toplevel hea…
6478768 
…dline, so what it can be easily referened from the jQAssistant reference
obfischer added a commit to jqassistant-archive/jqa-rdbms-plugin that referenced this issue Oct 16, 2020
@obfischer
[jqassistant-archive/jqa-manual#7] Assigned an id to the toplevel hea…
5cd09a6 
…dline, so what it can be easily referened from the jQAssistant reference
obfischer added a commit to jqassistant-archive/jqa-javaee6-plugin that referenced this issue Oct 16, 2020
@obfischer
[jqassistant-archive/jqa-manual#7] Assigned an id to the toplevel hea…
299203b 
…dline, so what it can be easily referened from the jQAssistant reference
obfischer added a commit to jqassistant-archive/jqa-testng-plugin that referenced this issue Oct 16, 2020
@obfischer
[jqassistant-archive/jqa-manual#7] Assigned an id to the toplevel hea…
1ce156a 
…dline, so what it can be easily referened from the jQAssistant reference
obfischer added a commit to jqassistant-archive/jqa-spring-plugin that referenced this issue Oct 16, 2020
@obfischer
[jqassistant-archive/jqa-manual#7] Assigned an id to the toplevel hea…
bc47d64 
…dline, so what it can be easily referened from the jQAssistant reference
obfischer added a commit to jqassistant-archive/jqa-m2repo-plugin that referenced this issue Oct 16, 2020
@obfischer
[jqassistant-archive/jqa-manual#7] Assigned an id to the toplevel hea…
4eaff73 
…dline, so what it can be easily referened from the jQAssistant reference
obfischer added a commit to jqassistant-archive/jqa-java8-plugin that referenced this issue Oct 16, 2020
@obfischer
[jqassistant-archive/jqa-manual#7] Assigned an id to the toplevel hea…
482b0af 
…dline, so what it can be easily referened from the jQAssistant reference
obfischer added a commit to jqassistant-archive/jqa-asciidoc-report-plugin that referenced this issue Oct 16, 2020
@obfischer
[jqassistant-archive/jqa-manual#7 Assigned an id to the toplevel head…
ebfa523 
…line, so what it can be easily referened from the jQAssistant Reference
obfischer added a commit to jqassistant-archive/jqa-tycho-plugin that referenced this issue Oct 16, 2020
@obfischer
[jqassistant-archive/jqa-manual#7] Assigned an id to the toplevel hea…
415801b 
…dline, so what it can be easily referened from the jQAssistant reference
obfischer added a commit to jqassistant-archive/jqa-jaxrs-plugin that referenced this issue Oct 16, 2020
@obfischer
[jqassistant-archive/jqa-manual#7] Assigned an id to the toplevel hea…
eeada87 
…dline, so what it can be easily referened from the jQAssistant reference
obfischer added a commit to jqassistant-archive/jqa-maven3-plugin that referenced this issue Oct 16, 2020
@obfischer
[jqassistant-archive/jqa-manual#7] Assigned an id to the toplevel hea…
64e907d 
…dline, so what it can be easily referened from the jQAssistant reference
obfischer added a commit to jqassistant-archive/jqa-java-plugin that referenced this issue Oct 16, 2020
@obfischer
[jqassistant-archive/jqa-manual#7] Assigned an id to the toplevel hea…
8f46658 
…dline, so what it can be easily referened from the jQAssistant reference
obfischer added a commit to jqassistant-archive/jqa-graphql-plugin that referenced this issue Oct 16, 2020
@obfischer
[jqassistant-archive/jqa-manual#7] Assigned an id to the toplevel hea…
1fa8d22 
…dline, so what it can be easily referened from the jQAssistant reference
obfischer added a commit to jqassistant-archive/jqa-graphml-plugin that referenced this issue Oct 16, 2020
@obfischer
[jqassistant-archive/jqa-manual#7] Assigned an id to the toplevel hea…
48d8af8 
…dline, so what it can be easily referened from the jQAssistant reference
obfischer added a commit to jqassistant-archive/jqa-yaml-plugin that referenced this issue Oct 16, 2020
@obfischer
[jqassistant-archive/jqa-manual#7] Assigned an id to the toplevel hea…
2474fc5 
…dline, so what it can be easily referened from the jQAssistant reference
obfischer added a commit to jqassistant-archive/jqa-plugin-common that referenced this issue Oct 16, 2020
@obfischer
[jqassistant-archive/jqa-manual#7] Assigned an id to the toplevel hea…
feeecd4 
…dline, so what it can be easily referened from the jQAssistant reference
obfischer added a commit to jqassistant-archive/jqa-xml-plugin that referenced this issue Oct 16, 2020
@obfischer
[jqassistant-archive/jqa-manual#7] Assigned an id to the toplevel hea…
d1dfc34 
…dline, so what it can be easily referened from the jQAssistant reference
obfischer added a commit that referenced this issue Oct 16, 2020
@obfischer
[#7] Added links to the documentation of the plugins to reference manual
ed7e132
obfischer added a commit to jqassistant-archive/jqa-asciidoctor-utilities that referenced this issue Oct 16, 2020
@obfischer
[jqassistant-archive/jqa-manual#7] The XSLT stylesheets generate now …
4e6f3a3 
…an id for every toplevel section title
obfischer added a commit to jqassistant-archive/jqa-jpa2-plugin that referenced this issue Oct 16, 2020
@obfischer
[jqassistant-archive/jqa-manual#7] Assigned an id to the toplevel hea…
8d1e169 
…dline, so what it can be easily referened from the jQAssistant reference
obfischer added a commit that referenced this issue Oct 16, 2020
@obfischer
[#7] Added links to the documentation of the plugins to reference manual
9285432
@obfischer
Copy link
Contributor Author

  • Create overview and entry document
  • Added links from the new reference to the existing manual for all plugins added up to version 1.8.x of jQA

obfischer added a commit that referenced this issue Oct 26, 2020
@obfischer
[#7] Added links to the documentation of the plugins to reference manual
783d6ba
@obfischer obfischer added status:done All work related to this issue has been done and removed status:in progress A human being is working on this problem labels Oct 26, 2020
yaseno2186 pushed a commit to jQAssistant/jqassistant that referenced this issue Jul 9, 2024
@obfischer
[jqassistant-archive/jqa-manual#7] Property asciidoctor.toplevelid wi…
6c7f58f 
…ll be now overhanded to the XSLT as parameter
yaseno2186 pushed a commit to jQAssistant/jqassistant that referenced this issue Jul 9, 2024
@obfischer
[jqassistant-archive/jqa-manual#7] Assigned an id to the toplevel hea…
aad431d 
…dline, so what it can be easily referened from the jQAssistant reference
yaseno2186 pushed a commit to jQAssistant/jqassistant that referenced this issue Jul 9, 2024
@obfischer
[jqassistant-archive/jqa-manual#7] Assigned an id to the toplevel hea…
eb3d67d 
…dline, so what it can be easily referened from the jQAssistant reference
yaseno2186 pushed a commit to jQAssistant/jqassistant that referenced this issue Jul 9, 2024
@obfischer
[jqassistant-archive/jqa-manual#7] Assigned an id to the toplevel hea…
df51abc 
…dline, so what it can be easily referened from the jQAssistant reference
yaseno2186 pushed a commit to jQAssistant/jqassistant that referenced this issue Jul 9, 2024
@obfischer
[jqassistant-archive/jqa-manual#7] Assigned an id to the toplevel hea…
b57341b 
…dline, so what it can be easily referened from the jQAssistant reference
yaseno2186 pushed a commit to jQAssistant/jqassistant that referenced this issue Jul 9, 2024
@obfischer
[jqassistant-archive/jqa-manual#7] Assigned an id to the toplevel hea…
671770c 
…dline, so what it can be easily referened from the jQAssistant reference
yaseno2186 pushed a commit to jQAssistant/jqassistant that referenced this issue Jul 9, 2024
@obfischer
[jqassistant-archive/jqa-manual#7] Assigned an id to the toplevel hea…
2d1096a 
…dline, so what it can be easily referened from the jQAssistant reference
yaseno2186 pushed a commit to jQAssistant/jqassistant that referenced this issue Jul 9, 2024
@obfischer
[jqassistant-archive/jqa-manual#7] Assigned an id to the toplevel hea…
8c15d83 
…dline, so what it can be easily referened from the jQAssistant reference
yaseno2186 pushed a commit to jQAssistant/jqassistant that referenced this issue Jul 9, 2024
@obfischer
[jqassistant-archive/jqa-manual#7] Added the basic structure for the …
070cc45 
…userguide as well as a very basic initial document for the reference.
yaseno2186 pushed a commit to jQAssistant/jqassistant that referenced this issue Jul 9, 2024
@obfischer
[jqassistant-archive/jqa-manual#7] Turned numbering of captions on an…
2c61119 
…d added some empty chapters to the reference manual
yaseno2186 pushed a commit to jQAssistant/jqassistant that referenced this issue Jul 9, 2024
@obfischer
[jqassistant-archive/jqa-manual#7] Small changes and fixes
1db69d0
yaseno2186 pushed a commit to jQAssistant/jqassistant that referenced this issue Jul 9, 2024
@obfischer
[jqassistant-archive/jqa-manual#7] Added links to the documentation o…
c67066e 
…f the plugins to reference manual
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@obfischer obfischer

Labels
status:done All work related to this issue has been done topic:documentation Changes or enhancements to the documentation are necessary for this issue type:task A piece of work that must be done, but does not represent a noticeable change for the user
Projects
None yet
Milestone
1.9.0
Development

No branches or pull requests
1 participant
@obfischer