Menu ▾ ▴

#592 Remove documentation index

v1.1.x
closed
Erik Hänel
None
v1.1.3
Change Request
2021-07-12
2021-06-15
Erik Hänel
No

Remove the documentation index file from the whole documentation logic. The index shall be created at start-up from the corresponding article files, which shall carry the necessary information for creating it (will need that the articles carry keywords). Keep in mind that some article files contain multiple articles.

Analysis:

This can be done by using tinyXML2 as parsing function and the functions to get all files in a folder might also be useful. The internal structure of the index should be kept mostly the same, where the saving part will be dropped and the loading part will be adapted to go through all available documentation files to extract the needed information.

Implementation:

  • Implementation: Implemented as proposed by the analysis.
  • Revision: [r909]
  • Implementation test: Index was recreated at start-up and the updates at plugin (de-)installation also worked as expected.

Documentation:

  • [x] ChangesLog updated
  • [x] Code changes commented
  • Documentation articles:
    • [x] corresponding documentation articles updated
    • [ ] new documentation articles created
    • [ ] not needed
  • Language files:
    • [x] corresponding language files updated
    • [ ] not needed

Tests:

Change works as intended. Documentation index is built-up automatically. No deviation detected.

Related

Commit: [r909]
Tickets: #582

Discussion

  • Erik Hänel

    Erik Hänel - 2021-06-20
    • status: open --> accepted
     

  • Erik Hänel

    Erik Hänel - 2021-06-20
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -1 +1,23 @@
 Remove the documentation index file from the whole documentation logic. The index shall be created at start-up from the corresponding article files, which shall carry the necessary information for creating it (will need that the articles carry keywords). Keep in mind that some article files contain multiple articles.
+
+###Analysis:
+(*Describe, what's the issue and which changes have to be made*)
+
+###Implementation:
+* Implementation: (*Describe, what you've changed*) 
+* Revision: [rXXX]
+* Implementation test: (*Describe the type of test, which you performed, and if it was successful*)
+
+###Documentation:
+* [ ] ChangesLog updated
+* [ ] Code changes commented
+* **Documentation articles:**

+    * [ ] corresponding documentation articles updated
+    * [ ] new documentation articles created
+    * [ ] not needed
+* **Language files:**
+    * [ ] corresponding language files updated
+    * [ ] not needed
+
+###Tests:
+(*Describe, which tests you performed and their outcome*)
    • status: accepted --> analyzing
     

  • Erik Hänel

    Erik Hänel - 2021-06-21
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -1,7 +1,7 @@
 Remove the documentation index file from the whole documentation logic. The index shall be created at start-up from the corresponding article files, which shall carry the necessary information for creating it (will need that the articles carry keywords). Keep in mind that some article files contain multiple articles.

 ###Analysis:
-(*Describe, what's the issue and which changes have to be made*)
+This can be done by using tinyXML2 as parsing function and the functions to get all files in a folder might also be useful. The internal structure of the index should be kept mostly the same, where the saving part will be dropped and the loading part will be adapted to go through all available documentation files to extract the needed information.

 ###Implementation:

 * Implementation: (*Describe, what you've changed*)
    • status: analyzing --> implementing
     

  • Erik Hänel

    Erik Hänel - 2021-06-23
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -4,19 +4,19 @@
 This can be done by using tinyXML2 as parsing function and the functions to get all files in a folder might also be useful. The internal structure of the index should be kept mostly the same, where the saving part will be dropped and the loading part will be adapted to go through all available documentation files to extract the needed information.

 ###Implementation:
-* Implementation: (*Describe, what you've changed*) 
-* Revision: [rXXX]
-* Implementation test: (*Describe the type of test, which you performed, and if it was successful*)
+* Implementation: Implemented as proposed by the analysis.
+* Revision: [r909]
+* Implementation test: Index was recreated at start-up and the updates at plugin (de-)installation also worked as expected.

 ###Documentation:
-* [ ] ChangesLog updated
-* [ ] Code changes commented
+* [x] ChangesLog updated
+* [x] Code changes commented

 * **Documentation articles:**
-    * [ ] corresponding documentation articles updated
+    * [x] corresponding documentation articles updated
     * [ ] new documentation articles created
     * [ ] not needed
 * **Language files:**
-    * [ ] corresponding language files updated
+    * [x] corresponding language files updated
     * [ ] not needed

 ###Tests:
    • status: implementing --> testing
     

    Related

    Commit: [r909]

  • Erik Hänel

    Erik Hänel - 2021-07-12
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -20,4 +20,4 @@

     * [ ] not needed

 ###Tests:
-(*Describe, which tests you performed and their outcome*)
+Change works as intended. Documentation index is built-up automatically. No deviation detected.
    • status: testing --> closed
     

Anonymous
Anonymous

Add attachments
Cancel





MongoDB Logo MongoDB