From 825c3a4a4b49545b92017cf5b9311f298fd2c3e2 Mon Sep 17 00:00:00 2001 From: abv Date: Thu, 1 Oct 2020 14:18:48 +0300 Subject: [PATCH] 0027191: Documentation - redesign of information architecture -- renaming (3) Move guides on documentation, tests, coding rules, contribution workflow to dox/contribution --- dox/FILES_HTML.txt | 12 ++++++------ dox/FILES_PDF.txt | 11 ++++++----- dox/{dev_guides => }/contribution/coding_rules.md | 0 .../dev_guides.md => contribution/contribution.md} | 0 .../contribution_workflow/contribution_workflow.md | 0 .../OCCT_ContributionWorkflow_V3_image001.svg | 0 .../OCCT_ContributionWorkflow_V3_image002.png | Bin .../documentation/documentation.md | 10 +++++----- .../documentation/images/documentation_folders.png | Bin .../documentation/images/documentation_miktex.png | Bin .../images/documentation_test_image.svg | 0 .../git_guide/git_guide.md | 0 .../git_guide/images/OCCT_GitGuide_V2_image005.png | Bin .../git_guide/images/OCCT_GitGuide_V2_image006.png | Bin .../git_guide/images/OCCT_GitGuide_V2_image007.png | Bin .../git_guide/images/OCCT_GitGuide_V2_image009.png | Bin .../git_guide/images/OCCT_GitGuide_V2_image012.png | Bin .../git_guide/images/OCCT_GitGuide_V2_image013.png | Bin .../git_guide/images/OCCT_GitGuide_V2_image014.png | Bin .../git_guide/images/OCCT_GitGuide_V2_image015.png | Bin .../git_guide/images/OCCT_GitGuide_V2_image016.png | Bin .../git_guide/images/OCCT_GitGuide_V2_image018.png | Bin .../git_guide/images/OCCT_GitGuide_V2_image019.png | Bin .../git_guide/images/OCCT_GitGuide_V2_image020.png | Bin .../git_guide/images/OCCT_GitGuide_V2_image021.png | Bin .../git_guide/images/OCCT_GitGuide_V2_image022.png | Bin .../git_guide/images/OCCT_GitGuide_V2_image023.png | Bin .../git_guide/images/OCCT_GitGuide_V2_image024.png | Bin .../git_guide/images/OCCT_GitGuide_V2_image025.png | Bin .../git_guide/images/OCCT_GitGuide_V2_image026.png | Bin .../git_guide/images/OCCT_GitGuide_V2_svgdiff.png | Bin .../tests/images/tests_image001.png | Bin dox/{dev_guides => contribution}/tests/tests.md | 2 +- 33 files changed, 18 insertions(+), 17 deletions(-) rename dox/{dev_guides => }/contribution/coding_rules.md (100%) rename dox/{dev_guides/dev_guides.md => contribution/contribution.md} (100%) rename dox/{dev_guides => contribution}/contribution_workflow/contribution_workflow.md (100%) rename dox/{dev_guides => contribution}/contribution_workflow/images/OCCT_ContributionWorkflow_V3_image001.svg (100%) rename dox/{dev_guides => contribution}/contribution_workflow/images/OCCT_ContributionWorkflow_V3_image002.png (100%) rename dox/{dev_guides => contribution}/documentation/documentation.md (97%) rename dox/{dev_guides => contribution}/documentation/images/documentation_folders.png (100%) rename dox/{dev_guides => contribution}/documentation/images/documentation_miktex.png (100%) rename dox/{dev_guides => contribution}/documentation/images/documentation_test_image.svg (100%) rename dox/{dev_guides => contribution}/git_guide/git_guide.md (100%) rename dox/{dev_guides => contribution}/git_guide/images/OCCT_GitGuide_V2_image005.png (100%) rename dox/{dev_guides => contribution}/git_guide/images/OCCT_GitGuide_V2_image006.png (100%) rename dox/{dev_guides => contribution}/git_guide/images/OCCT_GitGuide_V2_image007.png (100%) rename dox/{dev_guides => contribution}/git_guide/images/OCCT_GitGuide_V2_image009.png (100%) rename dox/{dev_guides => contribution}/git_guide/images/OCCT_GitGuide_V2_image012.png (100%) rename dox/{dev_guides => contribution}/git_guide/images/OCCT_GitGuide_V2_image013.png (100%) rename dox/{dev_guides => contribution}/git_guide/images/OCCT_GitGuide_V2_image014.png (100%) rename dox/{dev_guides => contribution}/git_guide/images/OCCT_GitGuide_V2_image015.png (100%) rename dox/{dev_guides => contribution}/git_guide/images/OCCT_GitGuide_V2_image016.png (100%) rename dox/{dev_guides => contribution}/git_guide/images/OCCT_GitGuide_V2_image018.png (100%) rename dox/{dev_guides => contribution}/git_guide/images/OCCT_GitGuide_V2_image019.png (100%) rename dox/{dev_guides => contribution}/git_guide/images/OCCT_GitGuide_V2_image020.png (100%) rename dox/{dev_guides => contribution}/git_guide/images/OCCT_GitGuide_V2_image021.png (100%) rename dox/{dev_guides => contribution}/git_guide/images/OCCT_GitGuide_V2_image022.png (100%) rename dox/{dev_guides => contribution}/git_guide/images/OCCT_GitGuide_V2_image023.png (100%) rename dox/{dev_guides => contribution}/git_guide/images/OCCT_GitGuide_V2_image024.png (100%) rename dox/{dev_guides => contribution}/git_guide/images/OCCT_GitGuide_V2_image025.png (100%) rename dox/{dev_guides => contribution}/git_guide/images/OCCT_GitGuide_V2_image026.png (100%) rename dox/{dev_guides => contribution}/git_guide/images/OCCT_GitGuide_V2_svgdiff.png (100%) rename dox/{dev_guides => contribution}/tests/images/tests_image001.png (100%) rename dox/{dev_guides => contribution}/tests/tests.md (99%) diff --git a/dox/FILES_HTML.txt b/dox/FILES_HTML.txt index 6aabaa6ee0..f82422068f 100644 --- a/dox/FILES_HTML.txt +++ b/dox/FILES_HTML.txt @@ -37,12 +37,12 @@ user_guides/inspector/inspector.md user_guides/brep_wp/brep_wp.md user_guides/vis/vis.md -dev_guides/dev_guides.md -dev_guides/documentation/documentation.md -dev_guides/contribution/coding_rules.md -dev_guides/contribution_workflow/contribution_workflow.md -dev_guides/git_guide/git_guide.md -dev_guides/tests/tests.md +contribution/contribution.md +contribution/documentation/documentation.md +contribution/coding_rules.md +contribution/contribution_workflow/contribution_workflow.md +contribution/git_guide/git_guide.md +contribution/tests/tests.md debug/debug.md upgrade/upgrade.md dev_guides/visualization/pbr_math.md diff --git a/dox/FILES_PDF.txt b/dox/FILES_PDF.txt index 8e1922147a..8aeb596584 100644 --- a/dox/FILES_PDF.txt +++ b/dox/FILES_PDF.txt @@ -20,11 +20,12 @@ user_guides/visualization/visualization.md user_guides/xde/xde.md user_guides/vis/vis.md -dev_guides/contribution_workflow/contribution_workflow.md -dev_guides/documentation/documentation.md -dev_guides/contribution/coding_rules.md -dev_guides/git_guide/git_guide.md -dev_guides/tests/tests.md +contribution/contribution_workflow/contribution_workflow.md +contribution/documentation/documentation.md +contribution/coding_rules.md +contribution/git_guide/git_guide.md +contribution/tests/tests.md + upgrade/upgrade.md dev_guides/visualization/pbr_math.md diff --git a/dox/dev_guides/contribution/coding_rules.md b/dox/contribution/coding_rules.md similarity index 100% rename from dox/dev_guides/contribution/coding_rules.md rename to dox/contribution/coding_rules.md diff --git a/dox/dev_guides/dev_guides.md b/dox/contribution/contribution.md similarity index 100% rename from dox/dev_guides/dev_guides.md rename to dox/contribution/contribution.md diff --git a/dox/dev_guides/contribution_workflow/contribution_workflow.md b/dox/contribution/contribution_workflow/contribution_workflow.md similarity index 100% rename from dox/dev_guides/contribution_workflow/contribution_workflow.md rename to dox/contribution/contribution_workflow/contribution_workflow.md diff --git a/dox/dev_guides/contribution_workflow/images/OCCT_ContributionWorkflow_V3_image001.svg b/dox/contribution/contribution_workflow/images/OCCT_ContributionWorkflow_V3_image001.svg similarity index 100% rename from dox/dev_guides/contribution_workflow/images/OCCT_ContributionWorkflow_V3_image001.svg rename to dox/contribution/contribution_workflow/images/OCCT_ContributionWorkflow_V3_image001.svg diff --git a/dox/dev_guides/contribution_workflow/images/OCCT_ContributionWorkflow_V3_image002.png b/dox/contribution/contribution_workflow/images/OCCT_ContributionWorkflow_V3_image002.png similarity index 100% rename from dox/dev_guides/contribution_workflow/images/OCCT_ContributionWorkflow_V3_image002.png rename to dox/contribution/contribution_workflow/images/OCCT_ContributionWorkflow_V3_image002.png diff --git a/dox/dev_guides/documentation/documentation.md b/dox/contribution/documentation/documentation.md similarity index 97% rename from dox/dev_guides/documentation/documentation.md rename to dox/contribution/documentation/documentation.md index 27e5498826..038a650b92 100644 --- a/dox/dev_guides/documentation/documentation.md +++ b/dox/contribution/documentation/documentation.md @@ -30,7 +30,7 @@ You can use *custom.bat* file to add necessary paths to the *PATH* variable. Note that in the process of PDF generation MiKTeX may need some packages not installed by default. We recommend setting option "Install missing packages on-the-fly" to "Ask me first" (default) during MiKTeX installation: -@figure{/dev_guides/documentation/images/documentation_miktex.png,"",320} +@figure{/contribution/documentation/images/documentation_miktex.png,"",320} On the first run of **pdflatex** it will open a dialog window prompting for installation of missing packages. Follow the instructions to proceed (define proxy settings if needed, select a mirror site to download from, etc.). @@ -102,7 +102,7 @@ The MarkDown files have a *.md extension and are based on rules described @subsection OCCT_DM_SECTION_3_2 Directory Structure -@figure{/dev_guides/documentation/images/documentation_folders.png,"",160} +@figure{/contribution/documentation/images/documentation_folders.png,"",160} Each document has its own folder if there are any images used in it. These images are stored in *images* subfolder. @@ -112,7 +112,7 @@ If you want to use the same image for several documents, you can place it in *do @verbatim -@figure{/dev_guides/documentation/images/documentation_test_image.svg,"",420} +@figure{/contribution/documentation/images/documentation_test_image.svg,"",420} @endverbatim @@ -399,12 +399,12 @@ Captions are included below the image; in PDF output the images with caption are Example: @verbatim - @figure{/dev_guides/documentation/images/documentation_test_image.svg,"Test SVG image"} + @figure{/contribution/documentation/images/documentation_test_image.svg,"Test SVG image"} @endverbatim is rendered as: -@figure{/dev_guides/documentation/images/documentation_test_image.svg,"Test SVG image",320} +@figure{/contribution/documentation/images/documentation_test_image.svg,"Test SVG image",320} We recommend using **Inkscape** for creation and edition of vector graphics. The graphics created in MS Word Draw and some other vector editors can be copy-pasted to Inkscape and saved as SVG images. diff --git a/dox/dev_guides/documentation/images/documentation_folders.png b/dox/contribution/documentation/images/documentation_folders.png similarity index 100% rename from dox/dev_guides/documentation/images/documentation_folders.png rename to dox/contribution/documentation/images/documentation_folders.png diff --git a/dox/dev_guides/documentation/images/documentation_miktex.png b/dox/contribution/documentation/images/documentation_miktex.png similarity index 100% rename from dox/dev_guides/documentation/images/documentation_miktex.png rename to dox/contribution/documentation/images/documentation_miktex.png diff --git a/dox/dev_guides/documentation/images/documentation_test_image.svg b/dox/contribution/documentation/images/documentation_test_image.svg similarity index 100% rename from dox/dev_guides/documentation/images/documentation_test_image.svg rename to dox/contribution/documentation/images/documentation_test_image.svg diff --git a/dox/dev_guides/git_guide/git_guide.md b/dox/contribution/git_guide/git_guide.md similarity index 100% rename from dox/dev_guides/git_guide/git_guide.md rename to dox/contribution/git_guide/git_guide.md diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image005.png b/dox/contribution/git_guide/images/OCCT_GitGuide_V2_image005.png similarity index 100% rename from dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image005.png rename to dox/contribution/git_guide/images/OCCT_GitGuide_V2_image005.png diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image006.png b/dox/contribution/git_guide/images/OCCT_GitGuide_V2_image006.png similarity index 100% rename from dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image006.png rename to dox/contribution/git_guide/images/OCCT_GitGuide_V2_image006.png diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image007.png b/dox/contribution/git_guide/images/OCCT_GitGuide_V2_image007.png similarity index 100% rename from dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image007.png rename to dox/contribution/git_guide/images/OCCT_GitGuide_V2_image007.png diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image009.png b/dox/contribution/git_guide/images/OCCT_GitGuide_V2_image009.png similarity index 100% rename from dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image009.png rename to dox/contribution/git_guide/images/OCCT_GitGuide_V2_image009.png diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image012.png b/dox/contribution/git_guide/images/OCCT_GitGuide_V2_image012.png similarity index 100% rename from dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image012.png rename to dox/contribution/git_guide/images/OCCT_GitGuide_V2_image012.png diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image013.png b/dox/contribution/git_guide/images/OCCT_GitGuide_V2_image013.png similarity index 100% rename from dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image013.png rename to dox/contribution/git_guide/images/OCCT_GitGuide_V2_image013.png diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image014.png b/dox/contribution/git_guide/images/OCCT_GitGuide_V2_image014.png similarity index 100% rename from dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image014.png rename to dox/contribution/git_guide/images/OCCT_GitGuide_V2_image014.png diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image015.png b/dox/contribution/git_guide/images/OCCT_GitGuide_V2_image015.png similarity index 100% rename from dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image015.png rename to dox/contribution/git_guide/images/OCCT_GitGuide_V2_image015.png diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image016.png b/dox/contribution/git_guide/images/OCCT_GitGuide_V2_image016.png similarity index 100% rename from dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image016.png rename to dox/contribution/git_guide/images/OCCT_GitGuide_V2_image016.png diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image018.png b/dox/contribution/git_guide/images/OCCT_GitGuide_V2_image018.png similarity index 100% rename from dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image018.png rename to dox/contribution/git_guide/images/OCCT_GitGuide_V2_image018.png diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image019.png b/dox/contribution/git_guide/images/OCCT_GitGuide_V2_image019.png similarity index 100% rename from dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image019.png rename to dox/contribution/git_guide/images/OCCT_GitGuide_V2_image019.png diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image020.png b/dox/contribution/git_guide/images/OCCT_GitGuide_V2_image020.png similarity index 100% rename from dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image020.png rename to dox/contribution/git_guide/images/OCCT_GitGuide_V2_image020.png diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image021.png b/dox/contribution/git_guide/images/OCCT_GitGuide_V2_image021.png similarity index 100% rename from dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image021.png rename to dox/contribution/git_guide/images/OCCT_GitGuide_V2_image021.png diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image022.png b/dox/contribution/git_guide/images/OCCT_GitGuide_V2_image022.png similarity index 100% rename from dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image022.png rename to dox/contribution/git_guide/images/OCCT_GitGuide_V2_image022.png diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image023.png b/dox/contribution/git_guide/images/OCCT_GitGuide_V2_image023.png similarity index 100% rename from dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image023.png rename to dox/contribution/git_guide/images/OCCT_GitGuide_V2_image023.png diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image024.png b/dox/contribution/git_guide/images/OCCT_GitGuide_V2_image024.png similarity index 100% rename from dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image024.png rename to dox/contribution/git_guide/images/OCCT_GitGuide_V2_image024.png diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image025.png b/dox/contribution/git_guide/images/OCCT_GitGuide_V2_image025.png similarity index 100% rename from dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image025.png rename to dox/contribution/git_guide/images/OCCT_GitGuide_V2_image025.png diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image026.png b/dox/contribution/git_guide/images/OCCT_GitGuide_V2_image026.png similarity index 100% rename from dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_image026.png rename to dox/contribution/git_guide/images/OCCT_GitGuide_V2_image026.png diff --git a/dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_svgdiff.png b/dox/contribution/git_guide/images/OCCT_GitGuide_V2_svgdiff.png similarity index 100% rename from dox/dev_guides/git_guide/images/OCCT_GitGuide_V2_svgdiff.png rename to dox/contribution/git_guide/images/OCCT_GitGuide_V2_svgdiff.png diff --git a/dox/dev_guides/tests/images/tests_image001.png b/dox/contribution/tests/images/tests_image001.png similarity index 100% rename from dox/dev_guides/tests/images/tests_image001.png rename to dox/contribution/tests/images/tests_image001.png diff --git a/dox/dev_guides/tests/tests.md b/dox/contribution/tests/tests.md similarity index 99% rename from dox/dev_guides/tests/tests.md rename to dox/contribution/tests/tests.md index 598eca207a..3164b2f02f 100644 --- a/dox/dev_guides/tests/tests.md +++ b/dox/contribution/tests/tests.md @@ -273,7 +273,7 @@ The names *begin, end, data, parse.rules, grids.list* and *cases.list* are reser General layout of test scripts is shown in Figure 1. -@figure{/dev_guides/tests/images/tests_image001.png,"Layout of tests folder",400} +@figure{/contribution/tests/images/tests_image001.png,"Layout of tests folder",400} @subsection testmanual_2_2 Test Groups