Bug 36987 - Reorganize structure on docs.univention.de
Reorganize structure on docs.univention.de
Status: CLOSED FIXED
Product: UCS manual
Classification: Unclassified
Component: Docbook
unspecified
Other Linux
: P5 normal (vote)
: UCS 4.0-4-errata
Assigned To: Philipp Hahn
Stefan Gohmann
:
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2014-11-25 08:40 CET by Stefan Gohmann
Modified: 2016-04-05 12:58 CEST (History)
2 users (show)

See Also:
What kind of report is it?: ---
What type of bug is this?: ---
Who will be affected by this bug?: ---
How will those affected feel about the bug?: ---
User Pain:
Enterprise Customer affected?:
School Customer affected?:
ISV affected?:
Waiting Support:
Flags outvoted (downgraded) after PO Review:
Ticket number:
Bug group (optional):
Max CVSS v3 score:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Stefan Gohmann univentionstaff 2014-11-25 08:40:19 CET
Currently, we have a flat structure in the docs directory on the download server. Thus we overwrite images if they have the same name in different UCS manuals.

We should consider the possibilities of Jenkins to build and announce the documentation.
Comment 1 Philipp Hahn univentionstaff 2015-04-01 13:50:14 CEST
docs.univention.de is now tracked in <svn+ssh://billy.knut.univention.de/var/svn/dev/trunk/docs.univention.de>
Comment 2 Philipp Hahn univentionstaff 2015-04-01 17:31:45 CEST
doc-common/docbook/webroot/
 contains only the bare minimum of what all documents share:
   css/
   img/: images for CSS, favicon.ico
   errorpage.php
   piwik.html
 illustrations/manual-feedback-button.svg is required for backward compatibility for now

doc-common/docbook/index/
 contains the JSON files to generate the index.html files.

doc-common/docbook/resources/
 contains additional resources needed for building the PDF versions.

And document should include its own illustrations[40]/ directory.
This needs further work to guarantee files are not overwritten.
Best would be to have one directory per manual with a top-level index.html and the required images.

Final webroot is now in $SVN/trunk/docs.univention.de/
See <https://hutten.knut.univention.de/mediawiki/index.php/Hinweise_zur_UCS-Dokumentation> for the process description.

WIP: Possible layout could become:
/css/
/img/
/ucs/ # Product
  ucs-4.0.pdf
  ucs-4.0/
    index.html
    index.de.html
    index.en.html
    *.png *.jpg
  extended-4.0/
    index.html
    index.de.html
    index.en.html
    *.png *.jpg
  ...
/ucsschool/
  ucsschool-4.0r2.pdf
  ucsschool-4.0r2/
    index.html
    index.de.html
    index.en.html
    *.png *.jpg
  ...
/ucc/
  ...

Or one more directory level between /$product/$version/$document{.pdf,/index.html,/*.jpg}?
Comment 3 Philipp Hahn univentionstaff 2016-01-06 13:23:08 CET
r66596 | Bug #36987 doc: Use common index generation
 The index files from branches/UCS-3.2,4.0,4.1 have been merged and moved to trunk/doc-common/docbook/index/
Comment 4 Philipp Hahn univentionstaff 2016-02-10 08:14:13 CET
Done for now: Each release has its own illustrations sub-directory with the shared pictures for that release.
Comment 5 Stefan Gohmann univentionstaff 2016-02-16 20:24:26 CET
OK, verified.