Skip to content

GitLab

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
research-topics-mat-tuhh research-topics-mat-tuhh
  • Project overview
    • Project overview
    • Details
    • Activity
    • Releases
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 10
    • Issues 10
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
  • Merge requests 4
    • Merge requests 4
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Operations
    • Operations
    • Incidents
    • Environments
  • Packages & Registries
    • Packages & Registries
    • Container Registry
  • Analytics
    • Analytics
    • CI/CD
    • Repository
    • Value Stream
  • Wiki
    • Wiki
  • Members
    • Members
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • Fabian Nuraddin Alexander Gabel
  • research-topics-mat-tuhhresearch-topics-mat-tuhh
  • Wiki
  • Repository Structure

Repository Structure · Changes

Page history
Update Repository Structure authored May 10, 2021 by Fabian Nuraddin Alexander Gabel's avatar Fabian Nuraddin Alexander Gabel
Hide whitespace changes
Inline Side-by-side
Showing with 9 additions and 11 deletions
+9 -11
  • Repository-Structure.md Repository-Structure.md +9 -11
  • No files found.
Repository-Structure.md 0 → 100644
View page @ 8bca9d32
# `/static`
For files that are not changed and included as they are on the production site.
## `/static/home` and `/static/forschung/{aa,cm,dm,nm,st}`
UTF-8 copies of the staff and chair `.html` pages from the production site. The folder naming and structure has been preserved. The contained files are used for title (name) extraction by the routines [`preproc_staff`]() and [`preproc_wg`]().
Staff files are named `key.html`, where `key` is and unique identifier (e.g. `fgabel`). These keys are also replaced by the preprocessors [`preproc_staff`]() and [`preproc_wg`]().
For the routine [`build_standalone`](), these files contain a `MARKER` that is replaced with the respective research topic links through the routing [`integrate_pandoc.sh`]() (deprecated) and [`replace_marker`]()
## `/static/include/`
### `/static/include{css,images,javascript}`
Contains the files for `css`, `javascript`, `images` contain copies from the production site and are used only for review purposes and therefore also copied for the review apps. These files are not needed for the production site, as they are already available and not to be changed by the delivery.
## `/static/include/html`
Contains `.html` files with `SSI`-directives that need to be included for use at the production site. If theses files are also included in versions for review, the review server needs to have an apache server with loaded `mod_include`. For local testing, use the provided [`alpine-www3-dev.Dockerfile`]() which resembles the virtualisation used for the review app hosted at www3-dev.tuhh.de.
## `/static/ssi`
### `/static/ssi/htaccess`
Use this as `.htaccess` file in order to activate SSI on the Apache server
### `topic_template.shtml`
Basic file template for the research topic pages on the prodcution site. SSI directives dynamically include the `.html` files from [`/static/include/html`] and also set the pages title.
```
EXPLAIN THE DIRECTIVES IN MORE DETAIL
```
This file also contains the following markers which is replaced by the routine [`replace_marker`]()
* `TOPIC-FILE-MARKER`: Name of the respective file
* `TOPIC-FILE-MARKER`: Title of the topic file
* `{project_root}` absolute path on the production system. This is necessary as the [review apps]() use a different folder structure (`/ref_name/ref_shortsha/` instead of just `/`)
## `/static/misc`
Miscellaneous files.
* `TUHH_BUILD_README.md` Markdown file with markers to be replaced during deployment:
![image](uploads/3ff15f2315f3ac81b2d4b6c7a559940c/image.png)
\ No newline at end of file
Clone repository
  • Continuous Integration and Continuous Deployment
  • Dependencies
  • Editing Markdown
  • Getting Started
  • Integrations
  • Maintenance
  • Postprocessing
  • Preprocessors
  • Program Flow
  • Repository Structure
  • Styleguide
  • Testing
  • Workflow
  • Home