Skip to content

Commit

Permalink
working on the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
brainfoolong committed Apr 25, 2023
1 parent d7d73bf commit 2ac8e2e
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 11 deletions.
1 change: 0 additions & 1 deletion appdata/modules/FramelixDocs/public/dist/css/docs.min.css
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,6 @@
align-items: center;
gap: 10px;
word-break: break-word;
color: var(--accent-heavy);
}
.framelix-content-inner .anchor-title a:any-link,
.framelix-modal-inner .anchor-title a:any-link {
Expand Down
15 changes: 8 additions & 7 deletions appdata/modules/FramelixDocs/src/View/CoreDev/Docker.php
Original file line number Diff line number Diff line change
Expand Up @@ -33,20 +33,21 @@ public function showContent(): void
occurs, the image will be rebuilt and uploaded to docker.
</p>
<?php
echo $this->getAnchoredTitle('building', 'Building in general');
echo $this->getAnchoredTitle('build', 'Build and deploy');
?>
<p>
Images are built only locally and pushed from local to Docker hub by hand. There is no fully automated
workflow for that right now.
The images are designed to be built with our Github workflow that build, verify, test and publish the image
to the docker hub. Only valid images are valid to be pushed to docker. This process is completely automated
and is triggered manually.
</p>
<p>
The script to build an image locally is <code>bash dev-scripts/build-image.sh</code>. It accepts a parameter
to define which version you are building.
The script to build an image locally is <code>bash dev-scripts/build-image.sh</code>.
It accepts a parameter to define which version you are building.
If you do development, you go with the <code>dev</code> version.
</p>
<p>
The script to push a container is <code>bash dev-scripts/docker-hub.sh</code>. It has various parameters
which are shown when you call the script without any of that parameters.
The script to push a container is <code>bash dev-scripts/docker-hub.sh</code>.
It has various parameters which are shown when you call the script without any of that parameters.
The docker hub push logic requires and forces a rebuild of the image locally, running all tests on that
image and only if everything is successfull, pushes the image to docker.
</p>
Expand Down
4 changes: 3 additions & 1 deletion appdata/modules/FramelixDocs/src/View/CoreDev/Framelix.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,14 @@ public function showContent(): void
echo $this->getAnchoredTitle('modules', 'Development modules');
?>
<p>
This repository have 4 modules, 3 of them have separate ports and entry points.
This repository have 5 modules, 4 of them have separate ports and entry points.
</p>
<ul>
<li>Framelix - This is the core which is just the Framelix Framework itself. Everything you modify here, is
used by every other module.
</li>
<li>FramelixDemo - A complete application (An accounting software demo). This show many use-cases of how you can use Framelix in action.
</li>
<li>FramelixDocs - This module contains the docs you are currently reading. So when you do changes in
Framelix, you also should update the docs according to your changes.
</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,6 @@
align-items: center;
gap: 10px;
word-break: break-word;
color: var(--accent-heavy);

a:any-link {
opacity: 0.3;
Expand Down
1 change: 0 additions & 1 deletion docker-build/entrypoint.sh
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ rm -f /framelix/system/READY
cecho b "# FRAMELIX DOCKER - 😜 Huhuu!"
echo ""


if [ -z "$FRAMELIX_MODULES" ]; then
cecho r "Env FRAMELIX_MODULES not set. Aborting."
exit 1
Expand Down

0 comments on commit 2ac8e2e

Please sign in to comment.